Skip to content

Home > resol-vbus-core > LiveEncoderConstructorOptions

LiveEncoderConstructorOptions interface

Options for the constructor of LiveEncoder.

Signature:

typescript
export interface LiveEncoderConstructorOptions

Properties

Property

Modifiers

Type

Description

baudrate?

number

(Optional) The baudrate.

energyGainPerMs?

number

(Optional) The energy gain per millisecond without transmission. Set to 0 to disable energy management.

energyLossPerByte?

number

(Optional) The energy loss per byte transmitted. Set to 0 to disable energy management.

maxEnergy?

number

(Optional) The maximum energy level. Set to 0 to disable energy management.

onIdle?

() => void

(Optional) Callback that informs when the encoder is idle.

onTransmit?

(buffer: Uint8Array) => void

(Optional) Callback that informs when data must be transmitted.