index :: net

net.mqtt.client

aliases: [mqtt.client]

MQTT client

available since version: 0.9.8

---

methods:

• close close MQTT connection
  

• connect connect to websocket server
  parameters:
  • URL mqtt server url, for ex.: mqtt://127.0.0.1:9000, tcp://user:pass@127.0.0.1:9000, ssl://user:pass@127.0.0.1 etc.
    type: symbol
    required: True
    
• publish publish message to topic
  parameters:

  • TOPIC topic
    type: symbol
    required: True
    

  • [ARGS] content
    type: list
    

• subscribe subscribe to topic
  parameters:
  • TOPIC topic
    type: symbol
    required: True
    
• unsubscribe unsubscribe from topic
  parameters:
  • TOPIC topic
    type: symbol
    required: True
    

properties:

• @id Get/set client id
  type: symbol
  default: pd_mqtt_client_0
  

• @mode Get/set parsing mode for incoming/outcoming messages. If 'fudi' - interpret data as Pd messages, if 'sym' - always interpret as symbols, 'data' - parse ceammc data, 'json' - convert json values to ceammc data.
  type: symbol
  enum: data, fudi, json, sym, bytes
  default: fudi
  

• @qos Get/set quality of service
  type: int
  enum: 0, 1, 2
  default: 0
  

• @retain Get/set retain flag
  type: bool
  default: 0
  

inlets:

• message input
  type: control

outlets:

• output messages: topic data
  type: control
• bang: on ping message
  type: control

keywords:

mqtt net client

Authors: Serge Poltavsky

License: GPL3 or later