Class FrontPanelWebAppBase

This class encapsulates the basic functionality of a web application using FrontPanel API via web socket interface.

Hierarchy

FrontPanelWebAppBase

Index

Properties

Accessors

Methods

Properties

Optional onAddDevice

onAddDevice: undefined | function

Optional onConfigure

onConfigure: undefined | function

Optional onConnect

onConnect: undefined | function

Optional onDisconnect

onDisconnect: undefined | function

Optional onRemoveDevice

onRemoveDevice: undefined | function

Accessors

configuredDevice

get configuredDevice(): string | undefined

- Defined in src/web-app/web-app-base.ts:56
The name of the currently configured device or undefined if not configured.

Returns string | undefined

devices

get devices(): string[]

- Defined in src/web-app/web-app-base.ts:48
The list of the devices on the server we're currently connected to.

Returns string[]

fp

get fp(): FrontPanel

- Defined in src/web-app/web-app-base.ts:21
The instance of FrontPanel. Throws an exception if the variable is undefined (use connectAndLogin to initialize it).

Returns FrontPanel

isConnected

get isConnected(): boolean

- Defined in src/web-app/web-app-base.ts:41
Whether the application is connected to the server.

Returns boolean

server

get server(): string | undefined

- Defined in src/web-app/web-app-base.ts:34
The name of the currently connected server or undefined if not connected.

Returns string | undefined

Methods

Protected Abstract _processError

_processError(e: any): void

- Defined in src/web-app/web-app-base.ts:217
Processes the error caught inside callAndCheckErrors. For example log an error and disconnect.

Parameters
- e: any
Returns void

Protected Abstract _updateConnectionStatus

_updateConnectionStatus(): Promise<void>

- Defined in src/web-app/web-app-base.ts:223
Updates the application UI when a connection or disconnection has occurred.

Returns Promise<void>

callAndCheckErrors

callAndCheckErrors(func: function): Promise<void>

- Defined in src/web-app/web-app-base.ts:153
Executes func and in case of an error call _processError and update the UI with _updateConnectionStatus.

Parameters
- func: function
  - - (): Promise<void>
    - Returns Promise<void>
Returns Promise<void>

configure

configure(device: string, file: Blob): Promise<void>

- Defined in src/web-app/web-app-base.ts:101
Configures the device with the given file.

Parameters
- device: string
- file: Blob
Returns Promise<void>

connectAndLogin

connectAndLogin(server: string, user: string, password: string): Promise<void>

- Defined in src/web-app/web-app-base.ts:74
Connects to the server and login with the given credentials.

Parameters
- server: string
- user: string
- password: string
Returns Promise<void>

disconnect

disconnect(): Promise<void>

- Defined in src/web-app/web-app-base.ts:91
Disconnects from the server if connected (do nothing if not connected).

Returns Promise<void>

httpBinaryRequest

httpBinaryRequest(path: string): Promise<Uint8Array>

- Defined in src/web-app/web-app-base.ts:198
Asynchronously sends the GET request and returns the [[Promise]] which will be resolved with the response as an array buffer when the request is complete.

Parameters
- path: string
Returns Promise<Uint8Array>

httpTextRequest

httpTextRequest(path: string): Promise<string>

- Defined in src/web-app/web-app-base.ts:208
Asynchronously sends the GET request and returns the [[Promise]] which will be resolved with the response text when the request is complete.

Parameters
- path: string
Returns Promise<string>

processServerNotifications

processServerNotifications(): Promise<void>

- Defined in src/web-app/web-app-base.ts:119
Waits for an unsolicited server reply and treats it as a server notification (throw an error on any other kind of replies). Processes device connection and disconnection notifications to update the list of devices and call onAddDevice and onRemoveDevice handlers. If the current configured device was disconnected, call disconnect.

Returns Promise<void>

repeatWhile

repeatWhile(condition: function, func: function, ms: number): Promise<void>

- Defined in src/web-app/web-app-base.ts:173
Executes func using setTimeout while condition returns true with ms timeout.

Parameters
- condition: function
  - - (): boolean
    - Returns boolean
- func: function
  - - (): void
    - Returns void
- ms: number
Returns Promise<void>

Generated using TypeDoc