Interface OsCommandResponse

Hierarchy

Properties

command? data? errorCode? errorDescription? errorName? fsBuffer? progress? request response

Properties

Optional command

command?: Uint8Array

The command that was sent to the device through the 0x1023:01 OS Command.

Optional data

data?: number[]

Array of numbers representing the received data.

The length of data depends on the response type. If the response number is 3 (Command completed with error and with response), the length can be up to 5 numbers; otherwise, it can be up to 6 numbers.

Optional errorCode

errorCode?: number

The error code is only set when the response number is 3 (Command completed with error and with response).

The meaning of the error code can be general or command specific. General error codes start at 254 and go downwards:

  • 254: Unsupported command
  • 253: Command timeout
  • 252: Command aborted
  • 251: Command not allowed OS command specific error codes start at 0 and go upwards.

Optional errorDescription

errorDescription?: string

The error description is derived from the OS command number and error code number. The purpose of the error description is to provide more information about the error than the name can.

Optional errorName

errorName?: string

The error name is derived from the OS command number and error code number.

Optional fsBuffer

fsBuffer?: null | Uint8Array

Stores the content of the fs-buffer file if accessed during the execution of the OS command.

Optional progress

progress?: number

Reported progress during the OS command execution.

The progress can be in the range from 0 to 100 and is computed from the command status. A status value between 100 and 200 indicates that the command is executing with a percentage (100 = 0%, 200 = 100%).

request

request: RequestStatus

Status of the request.

response

response: Uint8Array

Raw response as sent by the device.

Settings

Member Visibility

Theme

Generated using TypeDoc