Werksdiagnose – Plattform

Dieses Modul enthält die Plattformabstraktion für Diagnosefunktionen.

Zusammenfassung

Aufzählungen
otGpioMode{
  OT_GPIO_MODE_INPUT = 0,
  OT_GPIO_MODE_OUTPUT = 1
} 		enum
Definiert die GPS-Modi.

Funktionen
otPlatDiagAlarmCallback(otInstance *aInstance)
void
Verarbeitet das Alarmereignis.
otPlatDiagChannelSet(uint8_t aChannel)
void
Legt den Kanal für die Werksdiagnose fest.
otPlatDiagGpioGet(uint32_t aGpio, bool *aValue)
Ruft den GPIO-Wert ab.
otPlatDiagGpioGetMode(uint32_t aGpio, otGpioMode *aMode)
Ruft den GPS-Modus auf.
otPlatDiagGpioSet(uint32_t aGpio, bool aValue)
Legt den gpio-Wert fest.
otPlatDiagGpioSetMode(uint32_t aGpio, otGpioMode aMode)
Legt den GPS-Modus fest.
otPlatDiagModeGet(void)
bool
Gibt an, ob der Werksdiagnosemodus aktiviert ist.
otPlatDiagModeSet(bool aMode)
void
Aktiviert/deaktiviert den Werksdiagnosemodus.
otPlatDiagProcess(otInstance *aInstance, uint8_t aArgsLength, char *aArgs[], char *aOutput, size_t aOutputMaxLen)
Verarbeitet eine Befehlszeile für die Werksdiagnose.
otPlatDiagRadioGetPowerSettings(otInstance *aInstance, uint8_t aChannel, int16_t *aTargetPower, int16_t *aActualPower, uint8_t *aRawPowerSetting, uint16_t *aRawPowerSettingLength)
Rufe die Energieeinstellungen für den jeweiligen Kanal ab.
otPlatDiagRadioGetRawPowerSetting(otInstance *aInstance, uint8_t *aRawPowerSetting, uint16_t *aRawPowerSettingLength)
Rufen Sie die Einstellung für die Funkrohleistung für das Diagnosemodul ab.
otPlatDiagRadioRawPowerSettingEnable(otInstance *aInstance, bool aEnable)
Aktiviere/deaktiviere die Plattformebene, um die von otPlatDiagRadioSetRawPowerSetting() festgelegte Einstellung für den Stromverbrauch zu verwenden.
otPlatDiagRadioReceived(otInstance *aInstance, otRadioFrame *aFrame, otError aError)
void
Verarbeitet den empfangenen Funkframe.
otPlatDiagRadioSetRawPowerSetting(otInstance *aInstance, const uint8_t *aRawPowerSetting, uint16_t aRawPowerSettingLength)
Legt die Einstellung für die Funkrohleistung für das Diagnosemodul fest.
otPlatDiagRadioTransmitCarrier(otInstance *aInstance, bool aEnable)
Bahnsteigebene für die Übertragung der fortlaufenden Carrier Wave starten/stoppen.
otPlatDiagRadioTransmitStream(otInstance *aInstance, bool aEnable)
Plattformebene zum Übertragen des Zeichenstreams starten/beenden
otPlatDiagTxPowerSet(int8_t aTxPower)
void
Legt die Übertragungsleistung für die Werksdiagnose fest.

Aufzählungen

otGpioMode

 otGpioMode

Definiert die GPS-Modi.

Attribute
OT_GPIO_MODE_INPUT

Eingabemodus ohne Pull-Widerstand.

OT_GPIO_MODE_OUTPUT

Ausgabemodus.

Funktionen

otPlatDiagAlarmCallback

void otPlatDiagAlarmCallback(
  otInstance *aInstance
)

Verarbeitet das Alarmereignis.

Details
Parameter
[in] aInstance
Die OpenThread-Instanz für die aktuelle Anfrage.

otPlatDiagChannelSet

void otPlatDiagChannelSet(
  uint8_t aChannel
)

Legt den Kanal für die Werksdiagnose fest.

Details
Parameter
[in] aChannel
Der Kanalwert.

otPlatDiagGpioGet

otError otPlatDiagGpioGet(
  uint32_t aGpio,
  bool *aValue
)

Ruft den GPIO-Wert ab.

Details
Parameter
[in] aGpio
Die GPS-Nummer.
[out] aValue
Ein Zeiger, wo der gpio-Wert eingegeben werden soll.
Rückgabewerte
OT_ERROR_NONE
Der GPS-Wert wurde erfolgreich abgerufen.
OT_ERROR_FAILED
Beim Abrufen des gpio-Werts ist ein Plattformfehler aufgetreten.
OT_ERROR_INVALID_ARGS
aGpio wird nicht unterstützt oder aValue ist NULL.
OT_ERROR_INVALID_STATE
Diagnosemodus war nicht aktiviert oder aGpio ist nicht als Eingabe konfiguriert.
OT_ERROR_NOT_IMPLEMENTED
Diese Funktion ist auf der Plattform weder implementiert noch konfiguriert.

otPlatDiagGpioGetMode

otError otPlatDiagGpioGetMode(
  uint32_t aGpio,
  otGpioMode *aMode
)

Ruft den GPS-Modus auf.

Details
Parameter
[in] aGpio
Die GPS-Nummer.
[out] aMode
Ein Zeiger, wo der GPS-Modus platziert werden soll.
Rückgabewerte
OT_ERROR_NONE
GPS-Modus wurde abgerufen.
OT_ERROR_FAILED
Der von der Plattform zurückgegebene Modus ist in OpenThread nicht implementiert oder beim Abrufen des gpio-Modus ist ein Plattformfehler aufgetreten.
OT_ERROR_INVALID_ARGS
aGpio wird nicht unterstützt oder aMode ist NULL.
OT_ERROR_INVALID_STATE
Diagnosemodus wurde nicht aktiviert.
OT_ERROR_NOT_IMPLEMENTED
Diese Funktion ist auf der Plattform weder implementiert noch konfiguriert.

otPlatDiagGpioSet

otError otPlatDiagGpioSet(
  uint32_t aGpio,
  bool aValue
)

Legt den gpio-Wert fest.

Details
Parameter
[in] aGpio
Die GPS-Nummer.
[in] aValue
true, um das gpio auf High Level zu setzen, oder false, sonst false.
Rückgabewerte
OT_ERROR_NONE
GPS wurde festgelegt.
OT_ERROR_FAILED
Beim Festlegen des GPS ist ein Plattformfehler aufgetreten.
OT_ERROR_INVALID_ARGS
aGpio wird nicht unterstützt.
OT_ERROR_INVALID_STATE
Diagnosemodus war nicht aktiviert oder aGpio ist nicht als Ausgabe konfiguriert.
OT_ERROR_NOT_IMPLEMENTED
Diese Funktion ist auf der Plattform weder implementiert noch konfiguriert.

otPlatDiagGpioSetMode

otError otPlatDiagGpioSetMode(
  uint32_t aGpio,
  otGpioMode aMode
)

Legt den GPS-Modus fest.

Details
Parameter
[in] aGpio
Die GPS-Nummer.
[out] aMode
Der GPS-Modus.
Rückgabewerte
OT_ERROR_NONE
Gpio-Modus erfolgreich eingestellt.
OT_ERROR_FAILED
Beim Festlegen des GPS-Modus ist ein Plattformfehler aufgetreten.
OT_ERROR_INVALID_ARGS
aGpio oder aMode werden nicht unterstützt.
OT_ERROR_INVALID_STATE
Diagnosemodus wurde nicht aktiviert.
OT_ERROR_NOT_IMPLEMENTED
Diese Funktion ist auf der Plattform weder implementiert noch konfiguriert.

otPlatDiagModeGet

bool otPlatDiagModeGet(
  void
)

Gibt an, ob der Werksdiagnosemodus aktiviert ist.

Details
Rückgabe
TRUE, wenn der Werksdiagnosemodus aktiviert ist, andernfalls FALSE.

otPlatDiagModeSet

void otPlatDiagModeSet(
  bool aMode
)

Aktiviert/deaktiviert den Werksdiagnosemodus.

Details
Parameter
[in] aMode
TRUE, um den Diagnosemodus zu aktivieren, andernfalls FALSE.

otPlatDiagProcess

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

Verarbeitet eine Befehlszeile für die Werksdiagnose.

Die Ausgabe dieser Funktion (der in aOutput geschriebene Inhalt) MUSS mit \0 enden und \0 befindet sich im Ausgabepuffer.

Details
Parameter
[in] aInstance
Die OpenThread-Instanz für die aktuelle Anfrage.
[in] aArgsLength
Die Anzahl der Argumente in aArgs.
[in] aArgs
Die Argumente der Diagnose-Befehlszeile.
[out] aOutput
Das Ergebnis der Diagnoseausführung.
[in] aOutputMaxLen
Die Größe des Ausgabepuffers.
Rückgabewerte
OT_ERROR_INVALID_ARGS
Der Befehl wird unterstützt, aber ungültige Argumente angegeben.
OT_ERROR_NONE
Der Befehl wurde erfolgreich verarbeitet.
OT_ERROR_INVALID_COMMAND
Der Befehl ist ungültig oder wird nicht unterstützt.

otPlatDiagRadioGetPowerSettings

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

Rufe die Energieeinstellungen für den jeweiligen Kanal ab.

Details
Parameter
[in] aInstance
Die OpenThread-Instanzstruktur.
[in] aChannel
Der Radiokanal.
[out] aTargetPower
Die Zielleistung in 0,01 dBm.
[out] aActualPower
Die tatsächliche Leistung in 0,01 dBm.
[out] aRawPowerSetting
Ein Zeiger auf das Byte-Array für die Einstellung der Rohleistung.
[in,out] aRawPowerSettingLength
Bei der Eingabe ein Zeiger auf die Größe von aRawPowerSetting. Bei der Ausgabe ein Zeiger auf die Länge der Leistungseinstellungsdaten.
Rückgabewerte
OT_ERROR_NONE
Zielstärke wurde abgerufen.
OT_ERROR_INVALID_ARGS
aChannel ist ungültig, aActualPower, aRawPowerSetting oder aRawPowerSettingLength ist NULL oder zu kurz.
OT_ERROR_NOT_FOUND
Die Energieeinstellungen für aChannel wurden nicht gefunden.
OT_ERROR_NOT_IMPLEMENTED
Diese Methode ist nicht implementiert.

otPlatDiagRadioGetRawPowerSetting

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

Rufen Sie die Einstellung für die Funkrohleistung für das Diagnosemodul ab.

Details
Parameter
[in] aInstance
Die OpenThread-Instanzstruktur.
[out] aRawPowerSetting
Ein Zeiger auf das Byte-Array für die Einstellung der Rohleistung.
[in,out] aRawPowerSettingLength
Bei der Eingabe ein Zeiger auf die Größe von aRawPowerSetting. Bei der Ausgabe ein Zeiger auf die Länge der Leistungseinstellungsdaten.
Rückgabewerte
OT_ERROR_NONE
Die Einstellung für den Stromverbrauch wurde festgelegt.
OT_ERROR_INVALID_ARGS
aRawPowerSetting oder aRawPowerSettingLength ist NULL oder zu kurz.
OT_ERROR_NOT_FOUND
Die Einstellung für den Stromverbrauch ist nicht festgelegt.
OT_ERROR_NOT_IMPLEMENTED
Diese Methode ist nicht implementiert.

otPlatDiagRadioRawPowerSettingEnable

otError otPlatDiagRadioRawPowerSettingEnable(
  otInstance *aInstance,
  bool aEnable
)

Aktiviere/deaktiviere die Plattformebene, um die von otPlatDiagRadioSetRawPowerSetting() festgelegte Einstellung für den Stromverbrauch zu verwenden.

Details
Parameter
[in] aInstance
Die OpenThread-Instanzstruktur.
[in] aEnable
TRUE zum Aktivieren oder FALSE zum Deaktivieren der Rohleistungseinstellung.
Rückgabewerte
OT_ERROR_NONE
Die Einstellung für den Stromverbrauch wurde aktiviert/deaktiviert.
OT_ERROR_NOT_IMPLEMENTED
Diese Methode ist nicht implementiert.

otPlatDiagRadioReceived

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

Verarbeitet den empfangenen Funkframe.

Details
Parameter
[in] aInstance
Die OpenThread-Instanz für die aktuelle Anfrage.
[in] aFrame
Der empfangene Funkframe.
[in] aError
Der Status des empfangenen Funkframes.

otPlatDiagRadioSetRawPowerSetting

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

Legt die Einstellung für die Funkrohleistung für das Diagnosemodul fest.

Details
Parameter
[in] aInstance
Die OpenThread-Instanzstruktur.
[in] aRawPowerSetting
Ein Zeiger auf das Byte-Array für die Einstellung der Rohleistung.
[in] aRawPowerSettingLength
Die Länge von aRawPowerSetting.
Rückgabewerte
OT_ERROR_NONE
Die Einstellung für den Stromverbrauch wurde festgelegt.
OT_ERROR_INVALID_ARGS
aRawPowerSetting ist NULL oder aRawPowerSettingLength ist zu lang.
OT_ERROR_NOT_IMPLEMENTED
Diese Methode ist nicht implementiert.

otPlatDiagRadioTransmitCarrier

otError otPlatDiagRadioTransmitCarrier(
  otInstance *aInstance,
  bool aEnable
)

Bahnsteigebene für die Übertragung der fortlaufenden Carrier Wave starten/stoppen.

Details
Parameter
[in] aInstance
Die OpenThread-Instanzstruktur.
[in] aEnable
TRUE zum Aktivieren oder FALSE zum Deaktivieren der Plattformebene zur Übertragung der kontinuierlichen Carrier Wave.
Rückgabewerte
OT_ERROR_NONE
wurde aktiviert/deaktiviert .
OT_ERROR_INVALID_STATE
Das Radio befand sich nicht im Status „Empfangen“.
OT_ERROR_NOT_IMPLEMENTED
Diese Methode ist nicht implementiert.

otPlatDiagRadioTransmitStream

otError otPlatDiagRadioTransmitStream(
  otInstance *aInstance,
  bool aEnable
)

Plattformebene zum Übertragen des Zeichenstreams starten/beenden

Details
Parameter
[in] aInstance
Die OpenThread-Instanzstruktur.
[in] aEnable
TRUE zum Aktivieren oder FALSE zum Deaktivieren der Plattformebene zum Übertragen des Streams.
Rückgabewerte
OT_ERROR_NONE
Aktiviert/deaktiviert.
OT_ERROR_INVALID_STATE
Das Radio befand sich nicht im Status „Empfangen“.
OT_ERROR_NOT_IMPLEMENTED
Diese Funktion ist nicht implementiert.

otPlatDiagTxPowerSet

void otPlatDiagTxPowerSet(
  int8_t aTxPower
)

Legt die Übertragungsleistung für die Werksdiagnose fest.

Details
Parameter
[in] aTxPower
Der Wert der Übertragungsleistung.

Ressourcen

OpenThread API-Referenzthemen stammen aus dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen finden Sie unter Ressourcen. Dort können Sie auch einen Beitrag zu unserer Dokumentation leisten.