REST Resource: customers.deployments.devices

資源:裝置

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 入口網站 API 指定。

activeConfig

object (DeviceConfig)

僅供輸出。裝置目前向 SAS 註冊的設定。

state

enum (State)

僅供輸出。裝置狀態。

grants[]

object (DeviceGrant)

僅供輸出。裝置持有的授權。

displayName

string

裝置顯示名稱。

deviceMetadata

object (DeviceMetadata)

可由 SAS 入口網站和 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

裝置使用者的 ID。

callSign

string

裝置操作人員的呼號。

state

enum (State)

設定狀態。

isSigned

boolean

僅供輸出。設定是否已由 CPI 簽署。

updateTime

string (Timestamp format)

僅供輸出。上次編輯裝置設定的時間。

RFC3339 世界標準時間「Zulu」格式的時間戳記,精確度達奈秒單位,最多九個小數位數。例如:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

DeviceCategory

裝置的 FCC 類別 (如第 96 部分所定義)。

列舉
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

這個參數是裝置 EIRP 的上限,單位為 dBm/10MHz,且為介於 -127 和 +47 (dBm/10 MHz) 之間的整數 (含 -127 和 +47)。如果未納入,SAS 會將其解讀為裝置類別允許的最大 EIRP,單位為 dBm/10MHz。

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

裝置設定的狀態。只有處於 DEVICE_CONFIG_STATE_FINAL 狀態的設定,才能在 CBSD 註冊期間使用。

列舉
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 世界標準時間「Zulu」格式的時間戳記,精確度達奈秒單位,最多九個小數位數。例如:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

suspensionReason[]

string

如果補助金遭到停用,請說明停用原因。

grantId

string

授予項目 ID。

lastHeartbeatTransmitExpireTime

string (Timestamp format)

上次活動訊號的傳輸到期時間。

RFC3339 世界標準時間「Zulu」格式的時間戳記,精確度達奈秒單位,最多九個小數位數。例如:"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

動態產品廣告的 ID。

frequencyRange

object (FrequencyRange)

移動清單影響的頻率範圍。

DeviceMetadata

裝置資料可由 SAS 入口網站和註冊要求覆寫。

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)

僅供輸出。美國國家無線電靜區驗證資訊。

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

nodecustomer 下建立 device

createSigned

nodecustomer 下建立已簽署的 device

list

列出 nodecustomer 下的 devices