REST Resource: customers.deployments.devices

Ressource : Device

Représentation JSON
{
  "name": string,
  "fccId": string,
  "serialNumber": string,
  "preloadedConfig": {
    object (DeviceConfig)
  },
  "activeConfig": {
    object (DeviceConfig)
  },
  "state": enum (State),
  "grants": [
    {
      object (DeviceGrant)
    }
  ],
  "displayName": string,
  "deviceMetadata": {
    object (DeviceMetadata)
  },
  "currentChannels": [
    {
      object (ChannelWithScore)
    }
  ],
  "grantRangeAllowlists": [
    {
      object (FrequencyRange)
    }
  ]
}
Champs
name

string

Uniquement en sortie. Nom du chemin d'accès à la ressource.

fccId

string

Identifiant FCC de l'appareil.

serialNumber

string

Numéro de série attribué à l'appareil par le fabricant.

preloadedConfig

object (DeviceConfig)

Configuration de l'appareil, telle qu'elle est spécifiée via l'API du portail SAS.

activeConfig

object (DeviceConfig)

Uniquement en sortie. Configuration actuelle de l'appareil telle qu'enregistrée auprès du SAS.

state

enum (State)

Uniquement en sortie. État de l'appareil.

grants[]

object (DeviceGrant)

Uniquement en sortie. Autorisations détenues par l'appareil.

displayName

string

Nom à afficher de l'appareil.

deviceMetadata

object (DeviceMetadata)

Paramètres de l'appareil pouvant être remplacés par le portail SAS et les demandes d'enregistrement SAS.

currentChannels[]
(deprecated)

object (ChannelWithScore)

Uniquement en sortie. Chaînes actuelles avec scores.

grantRangeAllowlists[]

object (FrequencyRange)

Seules les plages figurant dans les listes d'autorisation sont disponibles pour les nouvelles autorisations.

DeviceConfig

Informations sur la configuration de l'appareil

Représentation JSON
{
  "category": enum (DeviceCategory),
  "model": {
    object (DeviceModel)
  },
  "airInterface": {
    object (DeviceAirInterface)
  },
  "installationParams": {
    object (InstallationParams)
  },
  "measurementCapabilities": [
    enum (MeasurementCapability)
  ],
  "userId": string,
  "callSign": string,
  "state": enum (State),
  "isSigned": boolean,
  "updateTime": string
}
Champs
category

enum (DeviceCategory)

Catégorie FCC de l'appareil.

model

object (DeviceModel)

Informations sur ce modèle d'appareil.

airInterface

object (DeviceAirInterface)

Informations sur l'interface radio de cet appareil.

installationParams

object (InstallationParams)

Paramètres d'installation de l'appareil.

measurementCapabilities[]

enum (MeasurementCapability)

Capacités de l'appareil en termes de création de rapports sur les mesures.

userId

string

Identifiant d'un utilisateur de l'appareil.

callSign

string

Indicatif de l'opérateur de l'appareil.

state

enum (State)

État de la configuration.

isSigned

boolean

Uniquement en sortie. Indique si la configuration a été signée par un CPI.

updateTime

string (Timestamp format)

Uniquement en sortie. Date et heure de la dernière modification de la configuration de l'appareil.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

DeviceCategory

Catégorie FCC de l'appareil, telle que définie par la section 96.

Enums
DEVICE_CATEGORY_UNSPECIFIED Catégorie d'appareil non spécifiée.
DEVICE_CATEGORY_A Catégorie A.
DEVICE_CATEGORY_B Catégorie B.

DeviceModel

Informations sur le modèle de l'appareil.

Représentation JSON
{
  "vendor": string,
  "name": string,
  "softwareVersion": string,
  "hardwareVersion": string,
  "firmwareVersion": string
}
Champs
vendor

string

Nom du fournisseur de l'appareil.

name

string

Nom du modèle de l'appareil.

softwareVersion

string

Version logicielle de l'appareil.

hardwareVersion

string

Version matérielle de l'appareil.

firmwareVersion

string

Version du micrologiciel de l'appareil.

DeviceAirInterface

Informations sur l'interface radio de l'appareil.

Représentation JSON
{
  "radioTechnology": enum (RadioTechnology),
  "supportedSpec": string
}
Champs
radioTechnology

enum (RadioTechnology)

Conditionnel. Ce champ spécifie la technologie d'accès radio utilisée pour le CBSD.

supportedSpec

string

Facultatif. Ce champ est lié à radioTechnology et fournit la spécification de l'interface radio à laquelle la CBSD est conforme au moment de l'enregistrement.

RadioTechnology

Types de technologies d'accès radio approuvés.

Enums
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

InstallationParams

Informations sur les paramètres d'installation de l'appareil.

Représentation JSON
{
  "latitude": number,
  "longitude": number,
  "height": number,
  "heightType": enum (HeightType),
  "horizontalAccuracy": number,
  "verticalAccuracy": number,
  "indoorDeployment": boolean,
  "antennaAzimuth": integer,
  "antennaDowntilt": integer,
  "antennaGain": integer,
  "eirpCapability": integer,
  "antennaBeamwidth": integer,
  "antennaModel": string,
  "cpeCbsdIndication": boolean
}
Champs
latitude

number

Latitude de l'emplacement de l'antenne de l'appareil en degrés par rapport au datum WGS 84. La plage autorisée est comprise entre -90,000000 et +90,000000. Les valeurs positives représentent les latitudes au nord de l'équateur, et les valeurs négatives celles au sud de l'équateur.

longitude

number

Longitude de l'emplacement de l'antenne de l'appareil en degrés par rapport au datum WGS 84. La plage autorisée est comprise entre -180,000000 et +180,000000. Les valeurs positives représentent les longitudes à l'est du premier méridien, et les valeurs négatives celles à l'ouest.

height

number

Hauteur de l'antenne de l'appareil en mètres. Lorsque la valeur du paramètre heightType est "AGL", la hauteur de l'antenne doit être indiquée par rapport au niveau du sol. Lorsque la valeur du paramètre heightType est "AMSL", elle est donnée par rapport au datum WGS84.

heightType

enum (HeightType)

Spécifie comment la hauteur est mesurée.

horizontalAccuracy

number

Nombre positif en mètres indiquant la précision de l'emplacement horizontal de l'antenne de l'appareil. Ce paramètre facultatif ne doit être présent que si sa valeur est inférieure à la distance de 50 mètres requise par la FCC.

verticalAccuracy

number

Nombre positif en mètres indiquant la précision de l'emplacement vertical de l'antenne de l'appareil. Ce paramètre facultatif ne doit être présent que si sa valeur est inférieure à la distance de 3 mètres requise par la FCC.

indoorDeployment

boolean

Indique si l'antenne de l'appareil est à l'intérieur ou non. true : indoor. false : extérieur.

antennaAzimuth

integer

Direction de visée du plan horizontal de l'antenne en degrés par rapport au nord géographique. La valeur de ce paramètre est un entier compris entre 0 et 359 inclus. Une valeur de 0 degré signifie le nord géographique, tandis qu'une valeur de 90 degrés signifie l'est. Ce paramètre est facultatif pour les appareils de catégorie A et conditionnel pour les appareils de catégorie B.

antennaDowntilt

integer

Inclinaison de l'antenne en degrés. Il s'agit d'un nombre entier compris entre -90 et +90 inclus. Une valeur négative signifie que l'antenne est inclinée vers le haut (au-dessus de l'horizontale). Ce paramètre est facultatif pour les appareils de catégorie A et conditionnel pour les appareils de catégorie B.

antennaGain

integer

Gain maximal de l'antenne en dBi. Ce paramètre est un entier dont la valeur est comprise entre -127 et +128 dBi (inclus).

eirpCapability

integer

Ce paramètre correspond à la PIRE maximale de l'appareil en dBm/10 MHz. Il s'agit d'un nombre entier compris entre -127 et +47 (dBm/10 MHz) inclus. Si elle n'est pas incluse, le SAS l'interprète comme la puissance isotrope rayonnée équivalente maximale autorisée en dBm/10 MHz pour la catégorie d'appareil.

antennaBeamwidth

integer

Largeur du faisceau d'antenne à 3 dB dans le plan horizontal, en degrés. Ce paramètre est un entier non signé dont la valeur est comprise entre 0 et 360 (degrés), inclus. Il est facultatif pour les appareils de catégorie A et conditionnel pour les appareils de catégorie B.

antennaModel

string

Si une antenne externe est utilisée, le modèle d'antenne peut être indiqué dans ce champ. La chaîne ne doit pas comporter plus de 128 octets.

cpeCbsdIndication

boolean

Si ce paramètre est présent, il indique si le CBSD est un CPE-CBSD ou non.

HeightType

Spécifie comment la hauteur est mesurée.

Enums
HEIGHT_TYPE_UNSPECIFIED Type de hauteur non spécifié.
HEIGHT_TYPE_AGL La hauteur AGL est mesurée par rapport au niveau du sol.
HEIGHT_TYPE_AMSL La hauteur AMSL est mesurée par rapport au niveau moyen de la mer.

MeasurementCapability

Capacité de mesure de l'appareil. Les valeurs sont définies par WINNF-SSC-0002.

Enums
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

État

État de la configuration de l'appareil. Seules les configurations à l'état DEVICE_CONFIG_STATE_FINAL peuvent être utilisées lors de l'enregistrement CBSD.

Enums
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

État

État de l'appareil.

Enums
DEVICE_STATE_UNSPECIFIED État non spécifié.
RESERVED L'appareil a été créé dans le portail SAS, mais n'a pas encore été enregistré auprès de SAS.
REGISTERED L'appareil est enregistré auprès du SAS.
DEREGISTERED L'appareil a été désenregistré auprès du SAS.

DeviceGrant

Autorisation d'appareil. Il s'agit d'une autorisation fournie par le système d'accès au spectre à un appareil pour qu'il puisse transmettre des données à l'aide de paramètres de fonctionnement spécifiques après un signal de présence réussi de l'appareil.

Représentation JSON
{
  "maxEirp": number,
  "frequencyRange": {
    object (FrequencyRange)
  },
  "state": enum (GrantState),
  "channelType": enum (ChannelType),
  "moveList": [
    {
      object (DpaMoveList)
    }
  ],
  "expireTime": string,
  "suspensionReason": [
    string
  ],
  "grantId": string,
  "lastHeartbeatTransmitExpireTime": string
}
Champs
maxEirp

number

Puissance isotrope rayonnée équivalente (PIRE) maximale autorisée par la subvention. La PIRE maximale est exprimée en dBm/MHz. La valeur maxEirp représente la PIRE moyenne (RMS) qui serait mesurée par la procédure définie dans la section 96.41(e)(3) de la partie 96 de la FCC.

frequencyRange

object (FrequencyRange)

Plage de fréquences de transmission.

state

enum (GrantState)

État de l'octroi.

channelType

enum (ChannelType)

Type de canal utilisé.

moveList[]

object (DpaMoveList)

Liste des DPA sur lesquelles cette subvention apparaît.

expireTime

string (Timestamp format)

Heure d'expiration de l'autorisation.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

suspensionReason[]

string

Motif(s) de la suspension si l'accès est suspendu.

grantId

string

ID d'autorisation.

lastHeartbeatTransmitExpireTime

string (Timestamp format)

Heure d'expiration de la transmission de la dernière pulsation.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

FrequencyRange

Plage de fréquence de low_frequency à high_frequency.

Représentation JSON
{
  "lowFrequencyMhz": number,
  "highFrequencyMhz": number
}
Champs
lowFrequencyMhz

number

Fréquence la plus basse de la plage de fréquences en MHz.

highFrequencyMhz

number

Fréquence la plus élevée de la plage de fréquences en MHz.

GrantState

État de l'autorisation.

Enums
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED L'accès a été accordé, mais l'appareil n'envoie pas de signal de présence.
GRANT_STATE_TERMINATED L'autorisation a été résiliée par le SAS.
GRANT_STATE_SUSPENDED La subvention a été suspendue par le SAS.
GRANT_STATE_AUTHORIZED L'appareil transmet actuellement des données.
GRANT_STATE_EXPIRED L'autorisation a expiré.

ChannelType

Enums
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

DpaMoveList

Entrée dans la liste des mouvements d'un DPA.

Représentation JSON
{
  "dpaId": string,
  "frequencyRange": {
    object (FrequencyRange)
  }
}
Champs
dpaId

string

ID du DPA.

frequencyRange

object (FrequencyRange)

Plage de fréquence affectée par la liste des mouvements.

DeviceMetadata

Données de l'appareil pouvant être remplacées par le portail SAS et les demandes d'enregistrement.

Représentation JSON
{
  "interferenceCoordinationGroup": string,
  "commonChannelGroup": string,
  "antennaModel": string,
  "nrqzValidated": boolean,
  "nrqzValidation": {
    object (NrqzValidation)
  }
}
Champs
interferenceCoordinationGroup

string

Groupe de coordination des interférences (ICG, Interference Coordination Group). Groupe de CBSD qui gèrent eux-mêmes leurs interférences avec le groupe. Pour en savoir plus, consultez CBRSA-TS-2001 V3.0.0.

commonChannelGroup

string

Groupe de canaux communs (GCC) Groupe de CBSD appartenant au même ICG et demandant une attribution de canal principal commune. Pour en savoir plus, consultez CBRSA-TS-2001 V3.0.0.

antennaModel

string

Modèle d'antenne à utiliser, le cas échéant. Format : RecordCreatorId:PatternId

nrqzValidated
(deprecated)

boolean

Uniquement en sortie. Définissez sur true si un CPI a confirmé qu'il s'est coordonné avec le bureau de la zone calme nationale.

nrqzValidation

object (NrqzValidation)

Uniquement en sortie. Informations de validation de la zone nationale de silence radio

NrqzValidation

Informations sur la validation de la National Radio Quiet Zone.

Représentation JSON
{
  "state": enum (State),
  "caseId": string,
  "latitude": number,
  "longitude": number,
  "cpiId": string
}
Champs
state

enum (State)

État des informations de validation de la NRQZ.

caseId

string

ID de la demande de validation.

latitude

number

Latitude de l'appareil associée à la validation.

longitude

number

Longitude de l'appareil associée à la validation.

cpiId

string

CPI qui a signé la validation.

État

État des informations de validation de la NRQZ.

Enums
STATE_UNSPECIFIED État non spécifié.
DRAFT État de brouillon.
FINAL État final.

ChannelWithScore

Chaîne avec score.

Représentation JSON
{
  "frequencyRange": {
    object (FrequencyRange)
  },
  "score": number
}
Champs
frequencyRange

object (FrequencyRange)

Plage de fréquences du canal.

score

number

Score de la chaîne, normalisé pour être compris dans la plage [0,100].

Méthodes

create

Crée un device sous un node ou un customer.

createSigned

Crée un device signé sous un node ou un customer.

list

Liste les devices sous un node ou un customer.