Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "protocol/index"

Index

Variables

Const defaultPublishEndpoint

defaultPublishEndpoint: "/usp/endpoint" = "/usp/endpoint"

Const defaultSubscribeEndpoint

defaultSubscribeEndpoint: "/usp/controller" = "/usp/controller"

Const ignorableTypes

ignorableTypes: string[] = ["operate"]

Functions

Const connect

  • Connect to device

    Parameters

    Returns Promise<AsyncMqttClient>

Const decode

  • Decode message

    Parameters

    Returns USPMessage

Const decodeGet

  • Decode get message

    Parameters

    • msg: any
    • id: string

    Returns GetMessage

Const encode

  • Encode message

    Parameters

    Returns { data: any; id: string }

    • data: any
    • id: string

Const encodeAdd

  • Encode add message

    Parameters

    Returns MQTTRequest

Const encodeDelete

  • Encode delete message

    Parameters

    • paths: string[]

    Returns MQTTRequest

Const encodeGet

  • Encode get message

    Parameters

    • paths: string[]

    Returns MQTTRequest

Const encodeOperate

  • encodeOperate(path: string, action: string, operateID: string, input?: undefined | object): MQTTRequest
  • Encode operate message

    Parameters

    • path: string
    • action: string
    • operateID: string
    • Optional input: undefined | object

    Returns MQTTRequest

Const encodeSet

  • Encode set message

    Parameters

    • path: string
    • value: any

    Returns MQTTRequest

Const extractType

  • Extract message type

    Parameters

    • msg: any

    Returns MessageType

Const mqtt

Generated using TypeDoc