Class MQTTLayer

constructor

• new MQTTLayer(uri, logger?, preTopic?, qos?, forwardToCustomTopics?): MQTTLayer

• Creates an instance of MQTTLayer.

  Memberof

  MQTTLayer

  Parameters

  • uri: string

    Uri of the Broker. e.g. mqtt://localhost:1883 or ws://localhost:9000.

  • Optional logger: ValidLoggerDefinition = "info"

    Logger level

  • Optional preTopic: string = ...

    Defaultly all messages will be published on the following topics: <preTopic>/nope/<eventname>. preTopic is defaultly set to the hostname of the node in which NoPE is running.

  • Optional qos: 0 | 1 | 2 = 2

    The QOS of mqtt. see https://www.hivemq.com/blog/mqtt-essentials-part-6-mqtt-quality-of-service-levels/ for more details. Default = Exactly once. Otherwise there might be an issue.

  • Optional forwardToCustomTopics: boolean = true

    The Layer is able to forward data, events etc to default ports. This flag enables this behavior

  Returns MQTTLayer

connected

considerConnection

forwardToCustomTopics

id

preTopic

qos

Readonly receivesOwnMessages

uri

dispose

• dispose(): Promise<void>

• Function to dispose the Interface.

  Returns

  nothing

  Returns Promise<void>

emit

• emit<T>(eventname, data): Promise<void>

• See emit

  Type Parameters

  • T extends keyof EventnameToEventType

  Parameters

  • eventname: T

  • data: EventnameToEventType[T]

  Returns Promise<void>

on

• on<T>(eventname, cb): Promise<void>

• See on

  Type Parameters

  • T extends keyof EventnameToEventType

  Parameters

  • eventname: T

  • cb: ((data) => void)

    • • (data): void

      • Parameters

        • data: EventnameToEventType[T]

        Returns void

  Returns Promise<void>