REST Resource: customers.deployments.devices

リソース: Device

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)
    }
  ]
}
フィールド
name

string

出力専用。リソースパス名。

fccId

string

デバイスの FCC ID。

serialNumber

string

デバイス メーカーによってデバイスに割り当てられたシリアル番号。

preloadedConfig

object (DeviceConfig)

SAS Portal API で指定されたデバイスの構成。

activeConfig

object (DeviceConfig)

出力専用。SAS に登録されているデバイスの現在の構成。

state

enum (State)

出力専用。デバイスの状態。

grants[]

object (DeviceGrant)

出力専用。デバイスが保持している権限。

displayName

string

デバイスの表示名。

deviceMetadata

object (DeviceMetadata)

SAS Portal と SAS 登録リクエストの両方でオーバーライドできるデバイス パラメータ。

currentChannels[]
(deprecated)

object (ChannelWithScore)

出力専用。スコアのある現在のチャンネル。

grantRangeAllowlists[]

object (FrequencyRange)

新しい付与に使用できるのは、許可リストに含まれる範囲のみです。

DeviceConfig

デバイスの構成に関する情報。

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
}
フィールド
category

enum (DeviceCategory)

デバイスの FCC カテゴリ。

model

object (DeviceModel)

このデバイスモデルに関する情報。

airInterface

object (DeviceAirInterface)

このデバイスのエア インターフェースに関する情報。

installationParams

object (InstallationParams)

デバイスのインストール パラメータ。

measurementCapabilities[]

enum (MeasurementCapability)

デバイスの測定レポート機能。

userId

string

デバイスユーザーの識別子。

callSign

string

デバイス オペレーターのコールサイン。

state

enum (State)

構成の状態。

isSigned

boolean

出力専用。構成が CPI によって署名されているかどうか。

updateTime

string (Timestamp format)

出力専用。デバイス構成が最後に編集された日時。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

DeviceCategory

第 96 部で定義されているデバイスの FCC カテゴリ。

列挙型
DEVICE_CATEGORY_UNSPECIFIED デバイス カテゴリが指定されていません。
DEVICE_CATEGORY_A カテゴリ A。
DEVICE_CATEGORY_B カテゴリ B。

DeviceModel

デバイスのモデルに関する情報。

JSON 表現
{
  "vendor": string,
  "name": string,
  "softwareVersion": string,
  "hardwareVersion": string,
  "firmwareVersion": string
}
フィールド
vendor

string

デバイス ベンダーの名前。

name

string

デバイスの機種名。

softwareVersion

string

デバイスのソフトウェア バージョン。

hardwareVersion

string

デバイスのハードウェア バージョン。

firmwareVersion

string

デバイスのファームウェア バージョン。

DeviceAirInterface

デバイスの無線インターフェースに関する情報。

JSON 表現
{
  "radioTechnology": enum (RadioTechnology),
  "supportedSpec": string
}
フィールド
radioTechnology

enum (RadioTechnology)

条件付き。このフィールドは、CBSD に使用される無線アクセス技術を指定します。

supportedSpec

string

省略可。このフィールドは radioTechnology に関連しており、登録時に CBSD が準拠している無線インターフェースの仕様を提供します。

RadioTechnology

承認された無線アクセス技術の種類。

列挙型
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

InstallationParams

デバイスのインストール パラメータに関する情報。

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
}
フィールド
latitude

number

WGS 84 測地系に対するデバイス アンテナ位置の緯度(度単位)。指定できる範囲は -90.000000 ~+90.000000 です。正の値は赤道より北の緯度を表し、負の値は赤道より南の緯度を表します。

longitude

number

WGS 84 測地系を基準としたデバイス アンテナ位置の経度(度単位)。許容範囲は -180.000000 ~+180.000000 です。正の値は本初子午線の東の経度を表し、負の値は本初子午線の西の経度を表します。

height

number

デバイスのアンテナの高さ(メートル単位)。heightType パラメータの値が「AGL」の場合、アンテナの高さは地上レベルを基準として指定する必要があります。heightType パラメータ値が「AMSL」の場合、WGS84 測地系を基準として指定されます。

heightType

enum (HeightType)

高さの測定方法を指定します。

horizontalAccuracy

number

デバイスのアンテナの水平位置の精度を示す正の数値(メートル単位)。この省略可能なパラメータは、値が FCC の要件である 50 メートル未満の場合にのみ存在します。

verticalAccuracy

number

デバイス アンテナの垂直位置の精度を示すメートル単位の正の数。この省略可能なパラメータは、値が FCC の要件である 3 メートル未満の場合にのみ存在します。

indoorDeployment

boolean

デバイスのアンテナが屋内にあるかどうか。true: 屋内。false: 屋外。

antennaAzimuth

integer

アンテナの水平面のボアサイト方向(真北からの角度)。このパラメータの値は、0 ~ 359 の整数です。0 度は真北、90 度は東を意味します。このパラメータは、カテゴリ A デバイスでは省略可能で、カテゴリ B デバイスでは条件付きで必須です。

antennaDowntilt

integer

アンテナのダウンチルト(度単位)。-90 ~+90 の範囲の整数値。負の値は、アンテナが上向き(水平より上)に傾いていることを意味します。このパラメータは、カテゴリ A デバイスでは省略可能で、カテゴリ B デバイスでは条件付きで必須です。

antennaGain

integer

アンテナのピーク利得(dBi 単位)。このパラメータは、-127 ~+128(dBi)の範囲の整数です。

eirpCapability

integer

このパラメータは、dBm/10MHz 単位のデバイスの最大 EIRP で、-127 ~+47(dBm/10 MHz)の範囲の整数です。含まれていない場合、SAS はデバイス カテゴリの dBm/10 MHz 単位の最大許容 EIRP として解釈します。

antennaBeamwidth

integer

水平面におけるアンテナの 3 dB アンテナ ビーム幅(度)。このパラメータは、0 ~ 360(度)の範囲の符号なし整数です。カテゴリ A デバイスでは省略可能、カテゴリ B デバイスでは条件付きです。

antennaModel

string

外部アンテナを使用する場合は、このフィールドでアンテナ モデルを任意で指定します。文字列の最大長は 128 オクテットです。

cpeCbsdIndication

boolean

このパラメータが存在する場合、CBSD が CPE-CBSD かどうかを指定します。

HeightType

高さの測定方法を指定します。

列挙型
HEIGHT_TYPE_UNSPECIFIED 高さのタイプが指定されていません。
HEIGHT_TYPE_AGL AGL 高度は地上レベルを基準に測定されます。
HEIGHT_TYPE_AMSL AMSL 高度は平均海面を基準に測定されます。

MeasurementCapability

デバイスの測定機能。値は WINNF-SSC-0002 で定義されています。

列挙型
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

デバイス構成の状態。CBSD 登録時に使用できるのは、状態が DEVICE_CONFIG_STATE_FINAL の構成のみです。

列挙型
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

デバイスの状態。

列挙型
DEVICE_STATE_UNSPECIFIED 未指定の状態
RESERVED SAS ポータルでデバイスが作成されているが、SAS に登録されていない。
REGISTERED デバイスが SAS に登録されている。
DEREGISTERED デバイスが SAS から登録解除されました。

DeviceGrant

デバイスの付与。これは、デバイスがハートビートに成功した後、指定された動作パラメータを使用して送信するために、スペクトラム アクセス システムからデバイスに提供される認証です。

JSON 表現
{
  "maxEirp": number,
  "frequencyRange": {
    object (FrequencyRange)
  },
  "state": enum (GrantState),
  "channelType": enum (ChannelType),
  "moveList": [
    {
      object (DpaMoveList)
    }
  ],
  "expireTime": string,
  "suspensionReason": [
    string
  ],
  "grantId": string,
  "lastHeartbeatTransmitExpireTime": string
}
フィールド
maxEirp

number

許可された最大等方性放射電力(EIRP)。最大 EIRP の単位は dBm/MHz です。maxEirp の値は、FCC パート 96.41(e)(3) で定義されている手順で測定される平均(RMS)EIRP を表します。

frequencyRange

object (FrequencyRange)

送信周波数帯域。

state

enum (GrantState)

権限付与の状態。

channelType

enum (ChannelType)

使用されたチャネルのタイプ。

moveList[]

object (DpaMoveList)

この権限が付与されている DPA 移動リスト。

expireTime

string (Timestamp format)

権限付与の有効期限。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

suspensionReason[]

string

権限付与が一時停止されている場合は、一時停止の理由。

grantId

string

権限付与 ID。

lastHeartbeatTransmitExpireTime

string (Timestamp format)

最後のハートビートの送信有効期限。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

FrequencyRange

周波数の範囲は low_frequencyhigh_frequency です。

JSON 表現
{
  "lowFrequencyMhz": number,
  "highFrequencyMhz": number
}
フィールド
lowFrequencyMhz

number

周波数帯の最低周波数(MHz)。

highFrequencyMhz

number

周波数帯の最高周波数(MHz)。

GrantState

権限付与の状態。

列挙型
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED 権限付与は行われたが、デバイスがその権限付与でハートビートを行っていない。
GRANT_STATE_TERMINATED 権限付与は SAS によって終了されました。
GRANT_STATE_SUSPENDED 権限付与は SAS によって一時停止されています。
GRANT_STATE_AUTHORIZED デバイスが現在送信中です。
GRANT_STATE_EXPIRED 付与の有効期限が切れています。

ChannelType

列挙型
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

DpaMoveList

DPA の移動リストのエントリ。

JSON 表現
{
  "dpaId": string,
  "frequencyRange": {
    object (FrequencyRange)
  }
}
フィールド
dpaId

string

DPA の ID。

frequencyRange

object (FrequencyRange)

移動リストが影響する周波数範囲。

DeviceMetadata

SAS Portal と登録リクエストの両方でオーバーライド可能なデバイスデータ。

JSON 表現
{
  "interferenceCoordinationGroup": string,
  "commonChannelGroup": string,
  "antennaModel": string,
  "nrqzValidated": boolean,
  "nrqzValidation": {
    object (NrqzValidation)
  }
}
フィールド
interferenceCoordinationGroup

string

干渉調整グループ(ICG)。グループ内の干渉を管理する CBSD のグループ。詳しくは、CBRSA-TS-2001 V3.0.0 をご覧ください。

commonChannelGroup

string

共通チャネル グループ(CCG)。同じ ICG 内の CBSD のグループが、共通のプライマリ チャネルの割り当てをリクエストしています。詳しくは、CBRSA-TS-2001 V3.0.0 をご覧ください。

antennaModel

string

入力されている場合、使用するアンテナ モデル パターン。形式は RecordCreatorId:PatternId です。

nrqzValidated
(deprecated)

boolean

出力専用。CPI が国立静穏区域事務所と連携していることを確認した場合は、true に設定します。

nrqzValidation

object (NrqzValidation)

出力専用。National Radio Quiet Zone の検証情報。

NrqzValidation

国立電波静穏圏の検証に関する情報。

JSON 表現
{
  "state": enum (State),
  "caseId": string,
  "latitude": number,
  "longitude": number,
  "cpiId": string
}
フィールド
state

enum (State)

NRQZ 検証情報の状態。

caseId

string

検証ケース ID。

latitude

number

検証に関連付けられているデバイスの緯度。

longitude

number

検証に関連付けられているデバイスの経度。

cpiId

string

検証に署名した CPI。

NRQZ 検証情報の状態。

列挙型
STATE_UNSPECIFIED 未指定の状態
DRAFT 下書きの状態。
FINAL 最終状態。

ChannelWithScore

スコア付きのチャネル。

JSON 表現
{
  "frequencyRange": {
    object (FrequencyRange)
  },
  "score": number
}
フィールド
frequencyRange

object (FrequencyRange)

チャネルの周波数帯域。

score

number

チャンネル スコア。[0,100] の範囲に正規化されています。

メソッド

create

node または customer の下に device を作成します。

createSigned

node または customer の下に署名付きの device を作成します。

list

node または customer の下に devices を一覧表示します。