DAPLink | DAPjs API Documentation

DAPLink Class

Hierarchy

CmsisDAP
- DAPLink

Implements

Proxy

Index

Constructors

constructor

Events

Properties

Constructors

constructor

new DAPLink(transport: Transport, mode?: DAPProtocol, clockFrequency?: number): DAPLink

Overrides CmsisDAP.constructor

DAPLink constructor

Parameters
- transport: Transport
  
  Debug transport to use
- Default value mode: DAPProtocol = DAPProtocol.DEFAULT
  
  Debug mode to use
- Default value clockFrequency: number = DEFAULT_CLOCK_FREQUENCY
  
  Communication clock frequency to use (default 10000000)
Returns DAPLink

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

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from DAPLink.addListener

Overrides EventEmitter.addListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

configureTransfer

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

Inherited from DAPLink.configureTransfer

Configure Transfer https://www.keil.com/pack/doc/CMSIS/DAP/html/group__DAP__TransferConfigure.html

Parameters
- idleCycles: number
  
  Number of extra idle cycles after each transfer
- waitRetry: number
  
  Number of transfer retries after WAIT response
- matchRetry: number
  
  Number of retries on reads with Value Match in DAP_Transfer
Returns Promise<void>

Promise

connect

connect(): Promise<void>

Implementation of Proxy.connect

Inherited from DAPLink.connect

Connect to target device

Returns Promise<void>

Promise

dapDelay

dapDelay(delay: number): Promise<void>

Inherited from DAPLink.dapDelay

Send Delay Command https://www.keil.com/pack/doc/CMSIS/DAP/html/group__DAP__Delay.html

Parameters
- delay: number
  
  Time to delay in microseconds
Returns Promise<void>

Promise

dapInfo

dapInfo(request: DAPInfoRequest): Promise<number | string>

Inherited from DAPLink.dapInfo

Get DAP information

Parameters
- request: DAPInfoRequest
  
  Type of information to get
Returns Promise<number | string>

Promise of number or string

disconnect

disconnect(): Promise<void>

Implementation of Proxy.disconnect

Inherited from DAPLink.disconnect

Disconnect from target device

Returns Promise<void>

Promise

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from DAPLink.emit

Overrides EventEmitter.emit

Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from DAPLink.eventNames

Overrides EventEmitter.eventNames

Returns Array<string | symbol>

flash

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

Flash the target

Parameters
- buffer: BufferSource
  
  The image to flash
- Default value pageSize: number = DEFAULT_PAGE_SIZE
  
  The page size to use (defaults to 62)
Returns Promise<void>

Promise

getMaxListeners

getMaxListeners(): number

Inherited from DAPLink.getMaxListeners

Overrides EventEmitter.getMaxListeners

Returns number

getSerialBaudrate

getSerialBaudrate(): Promise<number>

Get the serial baud rate setting

Returns Promise<number>

Promise of baud rate

listenerCount

listenerCount(type: string | symbol): number

Inherited from DAPLink.listenerCount

Overrides EventEmitter.listenerCount

Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from DAPLink.listeners

Overrides EventEmitter.listeners

Parameters
- event: string | symbol
Returns Function[]

on

on(event: string | symbol, listener: function): this

Inherited from DAPLink.on

Overrides EventEmitter.on

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from DAPLink.once

Overrides EventEmitter.once

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from DAPLink.prependListener

Overrides EventEmitter.prependListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from DAPLink.prependOnceListener

Overrides EventEmitter.prependOnceListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

reconnect

reconnect(): Promise<void>

Implementation of Proxy.reconnect

Inherited from DAPLink.reconnect

Reconnect to target device

Returns Promise<void>

Promise

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from DAPLink.removeAllListeners

Overrides EventEmitter.removeAllListeners

Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from DAPLink.removeListener

Overrides EventEmitter.removeListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

reset

reset(): Promise<boolean>

Implementation of Proxy.reset

Inherited from DAPLink.reset

Reset target device

Returns Promise<boolean>

Promise of whether a device specific reset sequence is implemented

serialRead

serialRead(): Promise<ArrayBuffer | undefined>

Read serial data

Returns Promise<ArrayBuffer | undefined>

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

setMaxListeners

setMaxListeners(n: number): this

Inherited from DAPLink.setMaxListeners

Overrides EventEmitter.setMaxListeners

Parameters
- n: number
Returns this

setSerialBaudrate

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

Set the serial baud rate setting

Parameters
- Default value 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
- Default value serialDelay: number = DEFAULT_SERIAL_DELAY
  
  The serial delay to use (default 100)
- Default value autoConnect: boolean = true
  
  whether to automatically connect to the target (default true)
Returns Promise<void>

stopSerialRead

stopSerialRead(): void

Stop listening for serial data

Returns void

swjClock

swjClock(clock: number): Promise<void>

Inherited from DAPLink.swjClock

Send an SWJ Clock value https://www.keil.com/pack/doc/CMSIS/DAP/html/group__DAP__SWJ__Clock.html

Parameters
- clock: number
  
  The SWJ clock value to send
Returns Promise<void>

Promise

swjPins

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

Inherited from DAPLink.swjPins

Read/Write SWJ Pins https://www.keil.com/pack/doc/CMSIS/DAP/html/group__DAP__SWJ__Pins.html

Parameters
- pinsOut: number
  
  Pin values to write
- pinSelect: number
  
  Maske to select output pins to change
- pinWait: number
  
  Time in microseconds to wait for output pin value to stabilize (0 - no wait, 1..3000000)
Returns Promise<number>

Promise

swjSequence

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

Inherited from DAPLink.swjSequence

Send an SWJ Sequence https://www.keil.com/pack/doc/CMSIS/DAP/html/group__DAP__SWJ__Sequence.html

Parameters
- sequence: BufferSource
  
  The sequence to send
- Default value bitLength: number = sequence.byteLength * 8
Returns Promise<void>

Promise

transfer

transfer(port: DAPPort, mode: DAPTransferMode, register: number, value?: undefined | number): Promise<number>

Implementation of Proxy.transfer

Inherited from DAPLink.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: undefined | number
  
  Any value to write
Returns Promise<number>

Promise of any value read

transfer(operations: DAPOperation[]): Promise<Uint32Array>

Implementation of Proxy.transfer

Inherited from DAPLink.transfer

Transfer data with multiple read or write operations

Parameters
- operations: DAPOperation[]
  
  The operations to use
Returns Promise<Uint32Array>

Promise of any values read

transferBlock

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

Implementation of Proxy.transferBlock

Inherited from DAPLink.transferBlock

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

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

Implementation of Proxy.transferBlock

Inherited from DAPLink.transferBlock

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

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from DAPLink.listenerCount

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number