Table des matières

TNY-360 Documentation

Error

Error module of the TNY-360 API (code 0x13).

This module contains actions related to error handling, diagnosis and reporting of the robot, such as retrieving error codes and descriptions.


List of actions

Here's a list of all the actions available in the error module:

0x13 - 0x00

error.getErrorCount

Gets the number of errors.


No arguments


Return Values

  • countuint16

    -

    The number of errors.

0x13 - 0x01

error.getErrorEventByIndex

Gets the error event at the specified index.


Arguments

  • indexuint16

    -

    The index of the error event to retrieve (0 is the most recent event).


Return Values

  • eventErrorEvent

    -

    The error event at the specified index.

0x13 - 0x02

error.getErrorEventById

Gets the error event with the specified event ID.


Arguments

  • event_iduint16

    -

    The event ID of the error event to retrieve.


Return Values

  • eventErrorEvent

    -

    The error event with the specified event ID.

0x13 - 0x03

error.clearErrorEvents

Clears all error events.


No arguments


No return values

List of types

Here's a list of all the types used in the error module:

ErrorEvent

Represents an error event that occurred in the system.


Fields

  • timestampMsuint32

    -

    The timestamp of the error event in milliseconds since system start.

  • eventIduint16

    -

    The unique event ID assigned to this error event.

  • moduleuint8

    -

    The module ID where the error occurred (see ModuleID).

  • subsystemuint8

    -

    The subsystem ID within the module where the error occurred.

  • codeuint8

    -

    The specific error code within the subsystem.

  • severityErrorSeverity

    -

    The severity level of the error (see ErrorSeverity).

  • payloadSizeuint8

    -

    The size of the payload data in bytes.

  • payloaduint8[32]

    -

    The payload data associated with the error event (up to 32 bytes).

ErrorSeverity

Represents the severity level of an error event.


Values

  • Trace

    -

    Low level problems (debug infos that would be useful in case of problems)

  • Warning

    -

    When non-critical issues occur that may cause further problems

  • Error

    -

    When important issues occur that will degrade normal operation

  • Critical

    -

    When critical issues occur, and the system should stop to prevent further damage