Class UartService

Embedded UART API service

Hierarchy (View Summary)

BaseEmbedService
- UartService

Index

Constructors

Methods

buildOptionsWithRequest clearWriteRead close open writeRead

Constructors

constructor

new UartService(): UartService
Returns UartService
Inherited from BaseEmbedService.constructor

Methods

`Protected` `Static`buildOptionsWithRequest

buildOptionsWithRequest(
    mType: string,
    shared: EmbedSharedParams,
    params?: null | EmbedRequestParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Construct embedded peripheral request object
Parameters
- mType: string
  Message type
- shared: EmbedSharedParams
  Shared request parameters
- params: null | EmbedRequestParams = null
  Request specific parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
Inherited from BaseEmbedService.buildOptionsWithRequest
- Defined in services/BaseEmbedService.ts:17

`Static`clearWriteRead

clearWriteRead(
    shared: EmbedSharedParams,
    params: WriteReadParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Clear buffers, Write to and read from UART
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: WriteReadParams
  Write and Read request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/UartService.ts:19

`Static`close

close(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Close UART
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/UartService.ts:34

`Static`open

open(
    shared: EmbedSharedParams,
    params: UartOpenParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Clear buffers, Write to and read from UART
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: UartOpenParams
  Write and Read request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/UartService.ts:50

`Static`writeRead

writeRead(
    shared: EmbedSharedParams,
    params: WriteReadParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Write to and read from UART
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: WriteReadParams
  Write and Read request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/UartService.ts:66