Close httplib2 connections.
Deletes a device.
Gets details about a device.
move(name, body=None, x__xgafv=None)
Moves a device under another node or customer.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a device.
signDevice(name, body=None, x__xgafv=None)
Signs a device.
updateSigned(name, body=None, x__xgafv=None)
Updates a signed device.
close()
Close httplib2 connections.
delete(name, x__xgafv=None)
Deletes a device.
Args:
name: string, Required. The name of the device. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Gets details about a device.
Args:
name: string, Required. The name of the device. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS.
"airInterface": { # Information about the device's air interface. # Information about this device's air interface.
"radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD.
"supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration.
},
"callSign": "A String", # The call sign of the device operator.
"category": "A String", # FCC category of the device.
"installationParams": { # Information about the device installation parameters. # Installation parameters for the device.
"antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices.
"antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices.
"antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices.
"antennaGain": 3.14, # Peak antenna gain in dBi. This parameter is a double with a value between -127 and +128 (dBi) inclusive. Part of Release 2 to support floating-point value
"antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets.
"cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not.
"eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category.
"height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum.
"heightType": "A String", # Specifies how the height is measured.
"horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters.
"indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor.
"latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator.
"longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.
"verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters.
},
"isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI.
"measurementCapabilities": [ # Measurement reporting capabilities of the device.
"A String",
],
"model": { # Information about the model of the device. # Information about this device model.
"firmwareVersion": "A String", # The firmware version of the device.
"hardwareVersion": "A String", # The hardware version of the device.
"name": "A String", # The name of the device model.
"softwareVersion": "A String", # The software version of the device.
"vendor": "A String", # The name of the device vendor.
},
"state": "A String", # State of the configuration.
"updateTime": "A String", # Output only. The last time the device configuration was edited.
"userId": "A String", # The identifier of a device user.
},
"currentChannels": [ # Output only. Current channels with scores.
{ # The channel with score.
"frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
"score": 3.14, # The channel score, normalized to be in the range [0,100].
},
],
"deviceMetadata": { # Device data overridable by both SAS Portal and registration requests. # Device parameters that can be overridden by both SAS Portal and SAS registration requests.
"antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: `RecordCreatorId:PatternId`
"commonChannelGroup": "A String", # Common Channel Group (CCG). A group of CBSDs in the same ICG requesting a common primary channel assignment. For more details, see [CBRSA-TS-2001 V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf).
"interferenceCoordinationGroup": "A String", # Interference Coordination Group (ICG). A group of CBSDs that manage their own interference with the group. For more details, see [CBRSA-TS-2001 V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf).
"nrqzValidated": True or False, # Output only. Set to `true` if a CPI has validated that they have coordinated with the National Quiet Zone office.
"nrqzValidation": { # Information about National Radio Quiet Zone validation. # Output only. National Radio Quiet Zone validation info.
"caseId": "A String", # Validation case ID.
"cpiId": "A String", # CPI who signed the validation.
"latitude": 3.14, # Device latitude that's associated with the validation.
"longitude": 3.14, # Device longitude that's associated with the validation.
"state": "A String", # State of the NRQZ validation info.
},
},
"displayName": "A String", # Device display name.
"fccId": "A String", # The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them.
"grantRangeAllowlists": [ # Only ranges that are within the allowlists are available for new grants.
{ # Frequency range from `low_frequency` to `high_frequency`.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
],
"grants": [ # Output only. Grants held by the device.
{ # Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device.
"channelType": "A String", # Type of channel used.
"expireTime": "A String", # The expiration time of the grant.
"frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
"grantId": "A String", # Grant Id.
"lastHeartbeatTransmitExpireTime": "A String", # The transmit expiration time of the last heartbeat.
"maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3).
"moveList": [ # The DPA move lists on which this grant appears.
{ # An entry in a DPA's move list.
"dpaId": "A String", # The ID of the DPA.
"frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
},
],
"state": "A String", # State of the grant.
"suspensionReason": [ # If the grant is suspended, the reason(s) for suspension.
"A String",
],
},
],
"name": "A String", # Output only. The resource path name.
"preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API.
"airInterface": { # Information about the device's air interface. # Information about this device's air interface.
"radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD.
"supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration.
},
"callSign": "A String", # The call sign of the device operator.
"category": "A String", # FCC category of the device.
"installationParams": { # Information about the device installation parameters. # Installation parameters for the device.
"antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices.
"antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices.
"antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices.
"antennaGain": 3.14, # Peak antenna gain in dBi. This parameter is a double with a value between -127 and +128 (dBi) inclusive. Part of Release 2 to support floating-point value
"antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets.
"cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not.
"eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category.
"height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum.
"heightType": "A String", # Specifies how the height is measured.
"horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters.
"indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor.
"latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator.
"longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.
"verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters.
},
"isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI.
"measurementCapabilities": [ # Measurement reporting capabilities of the device.
"A String",
],
"model": { # Information about the model of the device. # Information about this device model.
"firmwareVersion": "A String", # The firmware version of the device.
"hardwareVersion": "A String", # The hardware version of the device.
"name": "A String", # The name of the device model.
"softwareVersion": "A String", # The software version of the device.
"vendor": "A String", # The name of the device vendor.
},
"state": "A String", # State of the configuration.
"updateTime": "A String", # Output only. The last time the device configuration was edited.
"userId": "A String", # The identifier of a device user.
},
"serialNumber": "A String", # A serial number assigned to the device by the device manufacturer.
"state": "A String", # Output only. Device state.
}
move(name, body=None, x__xgafv=None)
Moves a device under another node or customer.
Args:
name: string, Required. The name of the device to move. (required)
body: object, The request body.
The object takes the form of:
{ # Request for MoveDevice.
"destination": "A String", # Required. The name of the new parent resource node or customer to reparent the device under.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a device.
Args:
name: string, Output only. The resource path name. (required)
body: object, The request body.
The object takes the form of:
{
"activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS.
"airInterface": { # Information about the device's air interface. # Information about this device's air interface.
"radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD.
"supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration.
},
"callSign": "A String", # The call sign of the device operator.
"category": "A String", # FCC category of the device.
"installationParams": { # Information about the device installation parameters. # Installation parameters for the device.
"antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices.
"antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices.
"antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices.
"antennaGain": 3.14, # Peak antenna gain in dBi. This parameter is a double with a value between -127 and +128 (dBi) inclusive. Part of Release 2 to support floating-point value
"antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets.
"cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not.
"eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category.
"height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum.
"heightType": "A String", # Specifies how the height is measured.
"horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters.
"indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor.
"latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator.
"longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.
"verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters.
},
"isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI.
"measurementCapabilities": [ # Measurement reporting capabilities of the device.
"A String",
],
"model": { # Information about the model of the device. # Information about this device model.
"firmwareVersion": "A String", # The firmware version of the device.
"hardwareVersion": "A String", # The hardware version of the device.
"name": "A String", # The name of the device model.
"softwareVersion": "A String", # The software version of the device.
"vendor": "A String", # The name of the device vendor.
},
"state": "A String", # State of the configuration.
"updateTime": "A String", # Output only. The last time the device configuration was edited.
"userId": "A String", # The identifier of a device user.
},
"currentChannels": [ # Output only. Current channels with scores.
{ # The channel with score.
"frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
"score": 3.14, # The channel score, normalized to be in the range [0,100].
},
],
"deviceMetadata": { # Device data overridable by both SAS Portal and registration requests. # Device parameters that can be overridden by both SAS Portal and SAS registration requests.
"antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: `RecordCreatorId:PatternId`
"commonChannelGroup": "A String", # Common Channel Group (CCG). A group of CBSDs in the same ICG requesting a common primary channel assignment. For more details, see [CBRSA-TS-2001 V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf).
"interferenceCoordinationGroup": "A String", # Interference Coordination Group (ICG). A group of CBSDs that manage their own interference with the group. For more details, see [CBRSA-TS-2001 V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf).
"nrqzValidated": True or False, # Output only. Set to `true` if a CPI has validated that they have coordinated with the National Quiet Zone office.
"nrqzValidation": { # Information about National Radio Quiet Zone validation. # Output only. National Radio Quiet Zone validation info.
"caseId": "A String", # Validation case ID.
"cpiId": "A String", # CPI who signed the validation.
"latitude": 3.14, # Device latitude that's associated with the validation.
"longitude": 3.14, # Device longitude that's associated with the validation.
"state": "A String", # State of the NRQZ validation info.
},
},
"displayName": "A String", # Device display name.
"fccId": "A String", # The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them.
"grantRangeAllowlists": [ # Only ranges that are within the allowlists are available for new grants.
{ # Frequency range from `low_frequency` to `high_frequency`.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
],
"grants": [ # Output only. Grants held by the device.
{ # Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device.
"channelType": "A String", # Type of channel used.
"expireTime": "A String", # The expiration time of the grant.
"frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
"grantId": "A String", # Grant Id.
"lastHeartbeatTransmitExpireTime": "A String", # The transmit expiration time of the last heartbeat.
"maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3).
"moveList": [ # The DPA move lists on which this grant appears.
{ # An entry in a DPA's move list.
"dpaId": "A String", # The ID of the DPA.
"frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
},
],
"state": "A String", # State of the grant.
"suspensionReason": [ # If the grant is suspended, the reason(s) for suspension.
"A String",
],
},
],
"name": "A String", # Output only. The resource path name.
"preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API.
"airInterface": { # Information about the device's air interface. # Information about this device's air interface.
"radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD.
"supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration.
},
"callSign": "A String", # The call sign of the device operator.
"category": "A String", # FCC category of the device.
"installationParams": { # Information about the device installation parameters. # Installation parameters for the device.
"antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices.
"antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices.
"antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices.
"antennaGain": 3.14, # Peak antenna gain in dBi. This parameter is a double with a value between -127 and +128 (dBi) inclusive. Part of Release 2 to support floating-point value
"antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets.
"cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not.
"eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category.
"height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum.
"heightType": "A String", # Specifies how the height is measured.
"horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters.
"indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor.
"latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator.
"longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.
"verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters.
},
"isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI.
"measurementCapabilities": [ # Measurement reporting capabilities of the device.
"A String",
],
"model": { # Information about the model of the device. # Information about this device model.
"firmwareVersion": "A String", # The firmware version of the device.
"hardwareVersion": "A String", # The hardware version of the device.
"name": "A String", # The name of the device model.
"softwareVersion": "A String", # The software version of the device.
"vendor": "A String", # The name of the device vendor.
},
"state": "A String", # State of the configuration.
"updateTime": "A String", # Output only. The last time the device configuration was edited.
"userId": "A String", # The identifier of a device user.
},
"serialNumber": "A String", # A serial number assigned to the device by the device manufacturer.
"state": "A String", # Output only. Device state.
}
updateMask: string, Fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS.
"airInterface": { # Information about the device's air interface. # Information about this device's air interface.
"radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD.
"supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration.
},
"callSign": "A String", # The call sign of the device operator.
"category": "A String", # FCC category of the device.
"installationParams": { # Information about the device installation parameters. # Installation parameters for the device.
"antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices.
"antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices.
"antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices.
"antennaGain": 3.14, # Peak antenna gain in dBi. This parameter is a double with a value between -127 and +128 (dBi) inclusive. Part of Release 2 to support floating-point value
"antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets.
"cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not.
"eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category.
"height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum.
"heightType": "A String", # Specifies how the height is measured.
"horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters.
"indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor.
"latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator.
"longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.
"verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters.
},
"isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI.
"measurementCapabilities": [ # Measurement reporting capabilities of the device.
"A String",
],
"model": { # Information about the model of the device. # Information about this device model.
"firmwareVersion": "A String", # The firmware version of the device.
"hardwareVersion": "A String", # The hardware version of the device.
"name": "A String", # The name of the device model.
"softwareVersion": "A String", # The software version of the device.
"vendor": "A String", # The name of the device vendor.
},
"state": "A String", # State of the configuration.
"updateTime": "A String", # Output only. The last time the device configuration was edited.
"userId": "A String", # The identifier of a device user.
},
"currentChannels": [ # Output only. Current channels with scores.
{ # The channel with score.
"frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
"score": 3.14, # The channel score, normalized to be in the range [0,100].
},
],
"deviceMetadata": { # Device data overridable by both SAS Portal and registration requests. # Device parameters that can be overridden by both SAS Portal and SAS registration requests.
"antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: `RecordCreatorId:PatternId`
"commonChannelGroup": "A String", # Common Channel Group (CCG). A group of CBSDs in the same ICG requesting a common primary channel assignment. For more details, see [CBRSA-TS-2001 V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf).
"interferenceCoordinationGroup": "A String", # Interference Coordination Group (ICG). A group of CBSDs that manage their own interference with the group. For more details, see [CBRSA-TS-2001 V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf).
"nrqzValidated": True or False, # Output only. Set to `true` if a CPI has validated that they have coordinated with the National Quiet Zone office.
"nrqzValidation": { # Information about National Radio Quiet Zone validation. # Output only. National Radio Quiet Zone validation info.
"caseId": "A String", # Validation case ID.
"cpiId": "A String", # CPI who signed the validation.
"latitude": 3.14, # Device latitude that's associated with the validation.
"longitude": 3.14, # Device longitude that's associated with the validation.
"state": "A String", # State of the NRQZ validation info.
},
},
"displayName": "A String", # Device display name.
"fccId": "A String", # The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them.
"grantRangeAllowlists": [ # Only ranges that are within the allowlists are available for new grants.
{ # Frequency range from `low_frequency` to `high_frequency`.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
],
"grants": [ # Output only. Grants held by the device.
{ # Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device.
"channelType": "A String", # Type of channel used.
"expireTime": "A String", # The expiration time of the grant.
"frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
"grantId": "A String", # Grant Id.
"lastHeartbeatTransmitExpireTime": "A String", # The transmit expiration time of the last heartbeat.
"maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3).
"moveList": [ # The DPA move lists on which this grant appears.
{ # An entry in a DPA's move list.
"dpaId": "A String", # The ID of the DPA.
"frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
},
],
"state": "A String", # State of the grant.
"suspensionReason": [ # If the grant is suspended, the reason(s) for suspension.
"A String",
],
},
],
"name": "A String", # Output only. The resource path name.
"preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API.
"airInterface": { # Information about the device's air interface. # Information about this device's air interface.
"radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD.
"supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration.
},
"callSign": "A String", # The call sign of the device operator.
"category": "A String", # FCC category of the device.
"installationParams": { # Information about the device installation parameters. # Installation parameters for the device.
"antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices.
"antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices.
"antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices.
"antennaGain": 3.14, # Peak antenna gain in dBi. This parameter is a double with a value between -127 and +128 (dBi) inclusive. Part of Release 2 to support floating-point value
"antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets.
"cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not.
"eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category.
"height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum.
"heightType": "A String", # Specifies how the height is measured.
"horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters.
"indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor.
"latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator.
"longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.
"verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters.
},
"isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI.
"measurementCapabilities": [ # Measurement reporting capabilities of the device.
"A String",
],
"model": { # Information about the model of the device. # Information about this device model.
"firmwareVersion": "A String", # The firmware version of the device.
"hardwareVersion": "A String", # The hardware version of the device.
"name": "A String", # The name of the device model.
"softwareVersion": "A String", # The software version of the device.
"vendor": "A String", # The name of the device vendor.
},
"state": "A String", # State of the configuration.
"updateTime": "A String", # Output only. The last time the device configuration was edited.
"userId": "A String", # The identifier of a device user.
},
"serialNumber": "A String", # A serial number assigned to the device by the device manufacturer.
"state": "A String", # Output only. Device state.
}
signDevice(name, body=None, x__xgafv=None)
Signs a device.
Args:
name: string, Output only. The resource path name. (required)
body: object, The request body.
The object takes the form of:
{ # Request for SignDevice.
"device": { # Required. The device to sign. The device fields name, fcc_id and serial_number must be set. The user_id field must be set.
"activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS.
"airInterface": { # Information about the device's air interface. # Information about this device's air interface.
"radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD.
"supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration.
},
"callSign": "A String", # The call sign of the device operator.
"category": "A String", # FCC category of the device.
"installationParams": { # Information about the device installation parameters. # Installation parameters for the device.
"antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices.
"antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices.
"antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices.
"antennaGain": 3.14, # Peak antenna gain in dBi. This parameter is a double with a value between -127 and +128 (dBi) inclusive. Part of Release 2 to support floating-point value
"antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets.
"cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not.
"eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category.
"height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum.
"heightType": "A String", # Specifies how the height is measured.
"horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters.
"indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor.
"latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator.
"longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.
"verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters.
},
"isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI.
"measurementCapabilities": [ # Measurement reporting capabilities of the device.
"A String",
],
"model": { # Information about the model of the device. # Information about this device model.
"firmwareVersion": "A String", # The firmware version of the device.
"hardwareVersion": "A String", # The hardware version of the device.
"name": "A String", # The name of the device model.
"softwareVersion": "A String", # The software version of the device.
"vendor": "A String", # The name of the device vendor.
},
"state": "A String", # State of the configuration.
"updateTime": "A String", # Output only. The last time the device configuration was edited.
"userId": "A String", # The identifier of a device user.
},
"currentChannels": [ # Output only. Current channels with scores.
{ # The channel with score.
"frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
"score": 3.14, # The channel score, normalized to be in the range [0,100].
},
],
"deviceMetadata": { # Device data overridable by both SAS Portal and registration requests. # Device parameters that can be overridden by both SAS Portal and SAS registration requests.
"antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: `RecordCreatorId:PatternId`
"commonChannelGroup": "A String", # Common Channel Group (CCG). A group of CBSDs in the same ICG requesting a common primary channel assignment. For more details, see [CBRSA-TS-2001 V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf).
"interferenceCoordinationGroup": "A String", # Interference Coordination Group (ICG). A group of CBSDs that manage their own interference with the group. For more details, see [CBRSA-TS-2001 V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf).
"nrqzValidated": True or False, # Output only. Set to `true` if a CPI has validated that they have coordinated with the National Quiet Zone office.
"nrqzValidation": { # Information about National Radio Quiet Zone validation. # Output only. National Radio Quiet Zone validation info.
"caseId": "A String", # Validation case ID.
"cpiId": "A String", # CPI who signed the validation.
"latitude": 3.14, # Device latitude that's associated with the validation.
"longitude": 3.14, # Device longitude that's associated with the validation.
"state": "A String", # State of the NRQZ validation info.
},
},
"displayName": "A String", # Device display name.
"fccId": "A String", # The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them.
"grantRangeAllowlists": [ # Only ranges that are within the allowlists are available for new grants.
{ # Frequency range from `low_frequency` to `high_frequency`.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
],
"grants": [ # Output only. Grants held by the device.
{ # Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device.
"channelType": "A String", # Type of channel used.
"expireTime": "A String", # The expiration time of the grant.
"frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
"grantId": "A String", # Grant Id.
"lastHeartbeatTransmitExpireTime": "A String", # The transmit expiration time of the last heartbeat.
"maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3).
"moveList": [ # The DPA move lists on which this grant appears.
{ # An entry in a DPA's move list.
"dpaId": "A String", # The ID of the DPA.
"frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
},
],
"state": "A String", # State of the grant.
"suspensionReason": [ # If the grant is suspended, the reason(s) for suspension.
"A String",
],
},
],
"name": "A String", # Output only. The resource path name.
"preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API.
"airInterface": { # Information about the device's air interface. # Information about this device's air interface.
"radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD.
"supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration.
},
"callSign": "A String", # The call sign of the device operator.
"category": "A String", # FCC category of the device.
"installationParams": { # Information about the device installation parameters. # Installation parameters for the device.
"antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices.
"antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices.
"antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices.
"antennaGain": 3.14, # Peak antenna gain in dBi. This parameter is a double with a value between -127 and +128 (dBi) inclusive. Part of Release 2 to support floating-point value
"antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets.
"cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not.
"eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category.
"height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum.
"heightType": "A String", # Specifies how the height is measured.
"horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters.
"indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor.
"latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator.
"longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.
"verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters.
},
"isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI.
"measurementCapabilities": [ # Measurement reporting capabilities of the device.
"A String",
],
"model": { # Information about the model of the device. # Information about this device model.
"firmwareVersion": "A String", # The firmware version of the device.
"hardwareVersion": "A String", # The hardware version of the device.
"name": "A String", # The name of the device model.
"softwareVersion": "A String", # The software version of the device.
"vendor": "A String", # The name of the device vendor.
},
"state": "A String", # State of the configuration.
"updateTime": "A String", # Output only. The last time the device configuration was edited.
"userId": "A String", # The identifier of a device user.
},
"serialNumber": "A String", # A serial number assigned to the device by the device manufacturer.
"state": "A String", # Output only. Device state.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
updateSigned(name, body=None, x__xgafv=None)
Updates a signed device.
Args:
name: string, Required. The name of the device to update. (required)
body: object, The request body.
The object takes the form of:
{ # Request for UpdateSignedDevice.
"encodedDevice": "A String", # Required. The JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the device. The user_id field must be set.
"installerId": "A String", # Required. Unique installer ID (CPI ID) from the Certified Professional Installers database.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS.
"airInterface": { # Information about the device's air interface. # Information about this device's air interface.
"radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD.
"supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration.
},
"callSign": "A String", # The call sign of the device operator.
"category": "A String", # FCC category of the device.
"installationParams": { # Information about the device installation parameters. # Installation parameters for the device.
"antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices.
"antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices.
"antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices.
"antennaGain": 3.14, # Peak antenna gain in dBi. This parameter is a double with a value between -127 and +128 (dBi) inclusive. Part of Release 2 to support floating-point value
"antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets.
"cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not.
"eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category.
"height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum.
"heightType": "A String", # Specifies how the height is measured.
"horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters.
"indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor.
"latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator.
"longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.
"verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters.
},
"isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI.
"measurementCapabilities": [ # Measurement reporting capabilities of the device.
"A String",
],
"model": { # Information about the model of the device. # Information about this device model.
"firmwareVersion": "A String", # The firmware version of the device.
"hardwareVersion": "A String", # The hardware version of the device.
"name": "A String", # The name of the device model.
"softwareVersion": "A String", # The software version of the device.
"vendor": "A String", # The name of the device vendor.
},
"state": "A String", # State of the configuration.
"updateTime": "A String", # Output only. The last time the device configuration was edited.
"userId": "A String", # The identifier of a device user.
},
"currentChannels": [ # Output only. Current channels with scores.
{ # The channel with score.
"frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
"score": 3.14, # The channel score, normalized to be in the range [0,100].
},
],
"deviceMetadata": { # Device data overridable by both SAS Portal and registration requests. # Device parameters that can be overridden by both SAS Portal and SAS registration requests.
"antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: `RecordCreatorId:PatternId`
"commonChannelGroup": "A String", # Common Channel Group (CCG). A group of CBSDs in the same ICG requesting a common primary channel assignment. For more details, see [CBRSA-TS-2001 V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf).
"interferenceCoordinationGroup": "A String", # Interference Coordination Group (ICG). A group of CBSDs that manage their own interference with the group. For more details, see [CBRSA-TS-2001 V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf).
"nrqzValidated": True or False, # Output only. Set to `true` if a CPI has validated that they have coordinated with the National Quiet Zone office.
"nrqzValidation": { # Information about National Radio Quiet Zone validation. # Output only. National Radio Quiet Zone validation info.
"caseId": "A String", # Validation case ID.
"cpiId": "A String", # CPI who signed the validation.
"latitude": 3.14, # Device latitude that's associated with the validation.
"longitude": 3.14, # Device longitude that's associated with the validation.
"state": "A String", # State of the NRQZ validation info.
},
},
"displayName": "A String", # Device display name.
"fccId": "A String", # The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them.
"grantRangeAllowlists": [ # Only ranges that are within the allowlists are available for new grants.
{ # Frequency range from `low_frequency` to `high_frequency`.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
],
"grants": [ # Output only. Grants held by the device.
{ # Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device.
"channelType": "A String", # Type of channel used.
"expireTime": "A String", # The expiration time of the grant.
"frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
"grantId": "A String", # Grant Id.
"lastHeartbeatTransmitExpireTime": "A String", # The transmit expiration time of the last heartbeat.
"maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3).
"moveList": [ # The DPA move lists on which this grant appears.
{ # An entry in a DPA's move list.
"dpaId": "A String", # The ID of the DPA.
"frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects.
"highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz.
"lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz.
},
},
],
"state": "A String", # State of the grant.
"suspensionReason": [ # If the grant is suspended, the reason(s) for suspension.
"A String",
],
},
],
"name": "A String", # Output only. The resource path name.
"preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API.
"airInterface": { # Information about the device's air interface. # Information about this device's air interface.
"radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD.
"supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration.
},
"callSign": "A String", # The call sign of the device operator.
"category": "A String", # FCC category of the device.
"installationParams": { # Information about the device installation parameters. # Installation parameters for the device.
"antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices.
"antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices.
"antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices.
"antennaGain": 3.14, # Peak antenna gain in dBi. This parameter is a double with a value between -127 and +128 (dBi) inclusive. Part of Release 2 to support floating-point value
"antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets.
"cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not.
"eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category.
"height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum.
"heightType": "A String", # Specifies how the height is measured.
"horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters.
"indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor.
"latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator.
"longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.
"verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters.
},
"isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI.
"measurementCapabilities": [ # Measurement reporting capabilities of the device.
"A String",
],
"model": { # Information about the model of the device. # Information about this device model.
"firmwareVersion": "A String", # The firmware version of the device.
"hardwareVersion": "A String", # The hardware version of the device.
"name": "A String", # The name of the device model.
"softwareVersion": "A String", # The software version of the device.
"vendor": "A String", # The name of the device vendor.
},
"state": "A String", # State of the configuration.
"updateTime": "A String", # Output only. The last time the device configuration was edited.
"userId": "A String", # The identifier of a device user.
},
"serialNumber": "A String", # A serial number assigned to the device by the device manufacturer.
"state": "A String", # Output only. Device state.
}