Skip to content

Home > resol-vbus-core-toolbox-scripts > mqttPublisher > MqttPublisherConstructorOptions

mqttPublisher.MqttPublisherConstructorOptions interface

The options passed to the constructor of MqttPublisher.

Signature:

typescript
export interface MqttPublisherConstructorOptions

Properties

Property

Modifiers

Type

Description

interval?

number

(Optional) The interval in milliseconds in which VBus values should be published.

mqttClientOptions?

mqtt.IClientOptions

(Optional) The options to pass to the mqtt.connectAsync() function.

packetFieldIds?

string[]

(Optional) Optional list of VBus packet field IDs to consider publishing.

url

string

The URL of the MQTT broker.

valueChangesOnly?

boolean

(Optional) Whether only changes VBus values should be published.

valueTopicPattern?

string

(Optional) The MQTT topic pattern, using %P as a placeholder for the VBus packet field ID.