Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DAPLink

DAPLink Class

Hierarchy

Index

Constructors

Events

Properties

Methods

Constructors

constructor

Events

Static EVENT_PROGRESS

EVENT_PROGRESS: string = 'progress'

Progress event

Static EVENT_SERIAL_DATA

EVENT_SERIAL_DATA: string = 'serial'

Serial read event

Properties

blockSize

blockSize: number

The maximum block size which can be transferred

connected

connected: boolean = false

Whether the device has been opened

operationCount

operationCount: number

The maximum DAPOperations which can be transferred

Methods

Protected clearAbort

  • clearAbort(abortMask?: number): Promise<void>

  • Clears the abort register of all error flags

    Parameters

    • abortMask: number = ...

      Optional AbortMask to use, otherwise clears all flags

    Returns Promise<void>

configureTransfer

  • configureTransfer(idleCycles: number, waitRetry: number, matchRetry: number): Promise<void>

connect

  • connect(): Promise<void>

dapDelay

  • dapDelay(delay: number): Promise<void>

dapInfo

disconnect

  • disconnect(): Promise<void>

flash

  • flash(buffer: BufferSource, pageSize?: number): Promise<void>

  • Flash the target

    Parameters

    • buffer: BufferSource

      The image to flash

    • pageSize: number = DEFAULT_PAGE_SIZE

      The page size to use (defaults to 62)

    Returns Promise<void>

    Promise

getSerialBaudrate

  • getSerialBaudrate(): Promise<number>

  • Get the serial baud rate setting

    Returns Promise<number>

    Promise of baud rate

reconnect

  • reconnect(): Promise<void>

reset

  • reset(): Promise<boolean>

Protected selectProtocol

Protected send

  • send(command: number, data?: ArrayBufferView | ArrayBuffer): Promise<DataView>

  • Send a command

    Parameters

    • command: number

      Command to send

    • Optional data: ArrayBufferView | ArrayBuffer

      Data to use

    Returns Promise<DataView>

    Promise of DataView

serialRead

  • serialRead(): Promise<undefined | ArrayBuffer>

  • Read serial data

    Returns Promise<undefined | ArrayBuffer>

    Promise of any arrayBuffer read

serialWrite

  • serialWrite(data: string): Promise<void>

  • Write serial data

    Parameters

    • data: string

      The data to write

    Returns Promise<void>

    Promise

setSerialBaudrate

  • setSerialBaudrate(baudrate?: number): Promise<void>

  • Set the serial baud rate setting

    Parameters

    • baudrate: number = DEFAULT_BAUDRATE

      The baudrate to use (defaults to 9600)

    Returns Promise<void>

    Promise

startSerialRead

  • startSerialRead(serialDelay?: number, autoConnect?: boolean): Promise<void>

  • Start listening for serial data

    Parameters

    • serialDelay: number = DEFAULT_SERIAL_DELAY

      The serial delay to use (default 100)

    • autoConnect: boolean = true

      whether to automatically connect to the target (default true)

    Returns Promise<void>

stopSerialRead

  • stopSerialRead(): void

swjClock

  • swjClock(clock: number): Promise<void>

swjPins

  • swjPins(pinsOut: number, pinSelect: number, pinWait: number): Promise<number>

swjSequence

  • swjSequence(sequence: BufferSource, bitLength?: number): Promise<void>

transfer

  • Transfer data with a single read or write operation

    Parameters

    • port: DAPPort

      Port type (debug port or access port)

    • mode: DAPTransferMode

      Whether to read or write

    • register: number

      The register to use

    • Optional value: number

      Any value to write

    Returns Promise<number>

    Promise of any value read

  • Transfer data with multiple read or write operations

    Parameters

    Returns Promise<Uint32Array>

    Promise of any values read

transferBlock

  • transferBlock(port: DAPPort, register: number, count: number): Promise<Uint32Array>
  • transferBlock(port: DAPPort, register: number, values: Uint32Array): Promise<undefined>

  • Read a block of data from a single register

    Parameters

    • port: DAPPort

      Port type (debug port or access port)

    • register: number

      The register to use

    • count: number

    Returns Promise<Uint32Array>

    Promise of values read

  • Write a block of data to a single register

    Parameters

    • port: DAPPort

      Port type (debug port or access port)

    • register: number

      The register to use

    • values: Uint32Array

      The values to write

    Returns Promise<undefined>

    Promise