本頁面由 Cloud Translation API 翻譯而成。

工廠診斷 - 平台

這個模組包含診斷功能的平台抽象層。

摘要

列舉
`otGpioMode{ OT_GPIO_MODE_INPUT = 0, OT_GPIO_MODE_OUTPUT = 1 }`	列舉此列舉會定義 gpio 模式。

Functions
`otPlatDiagAlarmCallback(otInstance *aInstance)`	`void` 這個函式會處理鬧鐘事件。
`otPlatDiagChannelSet(uint8_t aChannel)`	`void` 這個函式會設定要使用的頻道進行診斷。
`otPlatDiagGpioGet(uint32_t aGpio, bool *aValue)`	`otError` 這個函式會取得 gpio 值。
`otPlatDiagGpioGetMode(uint32_t aGpio, otGpioMode *aMode)`	`otError` 這個函式會取得 gpio 模式。
`otPlatDiagGpioSet(uint32_t aGpio, bool aValue)`	`otError` 這個函式會設定 gpio 值。
`otPlatDiagGpioSetMode(uint32_t aGpio, otGpioMode aMode)`	`otError` 這個函式會設定 gpio 模式。
`otPlatDiagModeGet(void)`	`bool` 這個函式可指出是否啟用工廠診斷模式。
`otPlatDiagModeSet(bool aMode)`	`void` 這項功能可啟用/停用工廠診斷模式。
`otPlatDiagProcess(otInstance aInstance, uint8_t aArgsLength, char aArgs[], char *aOutput, size_t aOutputMaxLen)`	`otError` 這個函式會處理工廠診斷指令列。
`otPlatDiagRadioGetPowerSettings(otInstance aInstance, uint8_t aChannel, int16_t aTargetPower, int16_t aActualPower, uint8_t aRawPowerSetting, uint16_t *aRawPowerSettingLength)`	`otError` 取得指定頻道的電源設定。
`otPlatDiagRadioGetRawPowerSetting(otInstance aInstance, uint8_t aRawPowerSetting, uint16_t *aRawPowerSettingLength)`	`otError` 取得診斷模組的無線電原始電源設定。
`otPlatDiagRadioRawPowerSettingEnable(otInstance *aInstance, bool aEnable)`	`otError` 啟用/停用平台層以使用「`otPlatDiagRadioSetRawPowerSetting()`」設定的原始電源設定。
`otPlatDiagRadioReceived(otInstance aInstance, otRadioFrame aFrame, otError aError)`	`void` 這個函式會處理收到的無線電框架。
`otPlatDiagRadioSetRawPowerSetting(otInstance aInstance, const uint8_t aRawPowerSetting, uint16_t aRawPowerSettingLength)`	`otError` 設定診斷模組的無線電原始電源設定。
`otPlatDiagRadioTransmitCarrier(otInstance *aInstance, bool aEnable)`	`otError` 啟動/停止平台層以傳輸連續的聲波。
`otPlatDiagTxPowerSet(int8_t aTxPower)`	`void` 這項函式可以設定用來進行工廠診斷的傳輸功率。

列舉

otGpioMode

 otGpioMode

此列舉會定義 gpio 模式。

屬性
`OT_GPIO_MODE_INPUT`	輸入模式時，沒有拉動電阻。
`OT_GPIO_MODE_OUTPUT`	輸出模式。

Functions

otPlatDiagAlarmCallback

void otPlatDiagAlarmCallback(
  otInstance *aInstance
)

這個函式會處理鬧鐘事件。

詳細資料

參數

[in] aInstance

目前要求的 OpenThread 執行個體。

otPlatDiagChannelSet

void otPlatDiagChannelSet(
  uint8_t aChannel
)

這個函式會設定要使用的頻道進行診斷。

詳細資料

參數

[in] aChannel

管道值。

otPlatDiagGpio 取得

otError otPlatDiagGpioGet(
  uint32_t aGpio,
  bool *aValue
)

這個函式會取得 gpio 值。

詳細資料

參數

`[in] aGpio`	gpio 號碼。
`[out] aValue`	這個位置指向放置 gpio 值的指標。

回傳值

`OT_ERROR_NONE`	已成功取得 gpio 值。
`OT_ERROR_FAILED`	取得 gpio 值時發生平台錯誤。
`OT_ERROR_INVALID_ARGS`	不支援 `aGpio` 或 `aValue` 為 NULL。
`OT_ERROR_INVALID_STATE`	診斷模式未啟用，或未將 `aGpio` 設為輸入內容。
`OT_ERROR_NOT_IMPLEMENTED`	這個函式並未在平台上實作或設定。

otPlatDiagGpioGetMode

otError otPlatDiagGpioGetMode(
  uint32_t aGpio,
  otGpioMode *aMode
)

這個函式會取得 gpio 模式。

詳細資料

參數

`[in] aGpio`	gpio 號碼。
`[out] aMode`	用於放置 gpio 模式的指標。

回傳值

`OT_ERROR_NONE`	已成功取得 gpio 模式。
`OT_ERROR_FAILED`	平台並未在 OpenThread 中實作此模式，或者在取得 gpio 模式時發生平台錯誤。
`OT_ERROR_INVALID_ARGS`	不支援 `aGpio` 或 `aMode` 為 NULL。
`OT_ERROR_INVALID_STATE`	未啟用診斷模式。
`OT_ERROR_NOT_IMPLEMENTED`	這個函式並未在平台上實作或設定。

otPlatDiagGpioSet

otError otPlatDiagGpioSet(
  uint32_t aGpio,
  bool aValue
)

這個函式會設定 gpio 值。

詳細資料

參數

`[in] aGpio`	gpio 號碼。
`[in] aValue`	將 gpio 設為高，否則傳回 false。

回傳值

`OT_ERROR_NONE`	已成功設定 gpio。
`OT_ERROR_FAILED`	設定 gpio 時發生平台錯誤。
`OT_ERROR_INVALID_ARGS`	系統不支援「`aGpio`」。
`OT_ERROR_INVALID_STATE`	診斷模式未啟用，或未將 `aGpio` 設為輸出內容。
`OT_ERROR_NOT_IMPLEMENTED`	這個函式並未在平台上實作或設定。

otPlatDiagGpioSetMode

otError otPlatDiagGpioSetMode(
  uint32_t aGpio,
  otGpioMode aMode
)

這個函式會設定 gpio 模式。

詳細資料

參數

`[in] aGpio`	gpio 號碼。
`[out] aMode`	gpio 模式。

回傳值

`OT_ERROR_NONE`	已成功設定 gpio 模式。
`OT_ERROR_FAILED`	設定 gpio 模式時發生平台錯誤。
`OT_ERROR_INVALID_ARGS`	不支援 `aGpio` 或 `aMode`。
`OT_ERROR_INVALID_STATE`	未啟用診斷模式。
`OT_ERROR_NOT_IMPLEMENTED`	這個函式並未在平台上實作或設定。

otPlatDiagModeGet

bool otPlatDiagModeGet(
  void
)

這個函式可指出是否啟用工廠診斷模式。

詳細資料
傳回	若已啟用工廠診斷模式，則傳回 TRUE，否則傳回 FALSE。

otPlatDiagModeSet

void otPlatDiagModeSet(
  bool aMode
)

這項功能可啟用/停用工廠診斷模式。

詳細資料

參數

[in] aMode

是 TRUE 以啟用診斷模式，否則為 FALSE。

otPlatDiagProcess

otError otPlatDiagProcess(
  otInstance *aInstance,
  uint8_t aArgsLength,
  char *aArgs[],
  char *aOutput,
  size_t aOutputMaxLen
)

這個函式會處理工廠診斷指令列。

這個函式 (寫入 aOutput 的內容) 的輸出結果必須以 \0 結尾，且 \0 位於輸出緩衝區內。

詳細資料

參數

`[in] aInstance`	目前要求的 OpenThread 執行個體。
`[in] aArgsLength`	`aArgs` 中的引數數量。
`[in] aArgs`	診斷指令列的引數。
`[out] aOutput`	診斷執行結果。
`[in] aOutputMaxLen`	輸出緩衝區的大小。

回傳值

`OT_ERROR_INVALID_ARGS`	支援指令，但提供的引數無效。
`OT_ERROR_NONE`	指令成功處理完畢。
`OT_ERROR_INVALID_COMMAND`	指令無效或不受支援。

otPlatDiagRadioGetPowerSettings

otError otPlatDiagRadioGetPowerSettings(
  otInstance *aInstance,
  uint8_t aChannel,
  int16_t *aTargetPower,
  int16_t *aActualPower,
  uint8_t *aRawPowerSetting,
  uint16_t *aRawPowerSettingLength
)

取得指定頻道的電源設定。

詳細資料

參數

`[in] aInstance`	OpenThread 執行個體結構。
`[in] aChannel`	廣播頻道。
`[out] aTargetPower`	目標功率為 0.01 dBm。
`[out] aActualPower`	實際功率為 0.01 dBm。
`[out] aRawPowerSetting`	指向原始電源設定位元組陣列的指標。
`[in,out] aRawPowerSettingLength`	輸入時，指向 `aRawPowerSetting` 大小的指標。輸出時，指向原始電源設定資料長度的指標。

回傳值

`OT_ERROR_NONE`	已成功取得目標電源。
`OT_ERROR_INVALID_ARGS`	「`aChannel`」無效、、`aActualPower`、`aRawPowerSetting` 或 `aRawPowerSettingLength` 為 NULL 或過短。
`OT_ERROR_NOT_FOUND`	找不到「`aChannel`」的電源設定。
`OT_ERROR_NOT_IMPLEMENTED`	未執行此方法。

otPlatDiagRadioGetRawPowerSetting

otError otPlatDiagRadioGetRawPowerSetting(
  otInstance *aInstance,
  uint8_t *aRawPowerSetting,
  uint16_t *aRawPowerSettingLength
)

取得診斷模組的無線電原始電源設定。

詳細資料

參數

`[in] aInstance`	OpenThread 執行個體結構。
`[out] aRawPowerSetting`	指向原始電源設定位元組陣列的指標。
`[in,out] aRawPowerSettingLength`	輸入時，指向 `aRawPowerSetting` 大小的指標。輸出時，指向原始電源設定資料長度的指標。

回傳值

`OT_ERROR_NONE`	成功完成原始電源設定。
`OT_ERROR_INVALID_ARGS`	`aRawPowerSetting` 或 `aRawPowerSettingLength` 為 NULL 或過短。
`OT_ERROR_NOT_FOUND`	未設定原始電源設定。
`OT_ERROR_NOT_IMPLEMENTED`	未執行此方法。

otPlatDiagRadioRawPowerSetting 啟用

otError otPlatDiagRadioRawPowerSettingEnable(
  otInstance *aInstance,
  bool aEnable
)

啟用/停用平台層以使用「otPlatDiagRadioSetRawPowerSetting()」設定的原始電源設定。

詳細資料

參數

`[in] aInstance`	OpenThread 執行個體結構。
`[in] aEnable`	TRUE 可啟用，設為 FALSE 可停用原始電源設定。

回傳值

`OT_ERROR_NONE`	已成功啟用/停用原始電源設定。
`OT_ERROR_NOT_IMPLEMENTED`	未執行此方法。

OTPPDiDiggRadioReceived

void otPlatDiagRadioReceived(
  otInstance *aInstance,
  otRadioFrame *aFrame,
  otError aError
)

這個函式會處理收到的無線電框架。

詳細資料

參數

`[in] aInstance`	目前要求的 OpenThread 執行個體。
`[in] aFrame`	收到的無線電畫面。
`[in] aError`	收到的無線電畫面狀態。

otPlatDiagRadioSetRawPowerSetting

otError otPlatDiagRadioSetRawPowerSetting(
  otInstance *aInstance,
  const uint8_t *aRawPowerSetting,
  uint16_t aRawPowerSettingLength
)

設定診斷模組的無線電原始電源設定。

詳細資料

參數

`[in] aInstance`	OpenThread 執行個體結構。
`[in] aRawPowerSetting`	指向原始電源設定位元組陣列的指標。
`[in] aRawPowerSettingLength`	`aRawPowerSetting` 的長度。

回傳值

`OT_ERROR_NONE`	成功完成原始電源設定。
`OT_ERROR_INVALID_ARGS`	`aRawPowerSetting` 為 NULL，或 `aRawPowerSettingLength` 過長。
`OT_ERROR_NOT_IMPLEMENTED`	未執行此方法。

otPlatDiagRadioTransmitCarrier

otError otPlatDiagRadioTransmitCarrier(
  otInstance *aInstance,
  bool aEnable
)

啟動/停止平台層以傳輸連續的聲波。

詳細資料

參數

`[in] aInstance`	OpenThread 執行個體結構。
`[in] aEnable`	設為 TRUE 可停用；設為 FALSE 可停用平台層傳輸傳輸傳輸聲波。

回傳值

`OT_ERROR_NONE`	已成功啟用/停用。
`OT_ERROR_INVALID_STATE`	收音機未處於「接收」狀態。
`OT_ERROR_NOT_IMPLEMENTED`	未執行此方法。

otPlatDiagTxPowerSet

void otPlatDiagTxPowerSet(
  int8_t aTxPower
)

這項函式可以設定用來進行工廠診斷的傳輸功率。

詳細資料

參數

[in] aTxPower

發射功率值。

資源

OpenThread API 參考資料主題來自原始碼，可在 GitHub 取得。如需詳細資訊或為說明文件貢獻一己之力，請參閱資源。