Plugin MQTT

From VoxCommando
Jump to: navigation, search

Go to the main Plugins page.

Go to the complete Plugin List.


Plugin Description

Description of the plugin

Actions for the MQTT plugin

Connect

MQTT.Connect
Attempt to (re)connect to MQTT broker.

Publish

MQTT.Publish
Publish <Payload> to <Topic> on MQTT server.

  • Parameters: 2
  1. Topic : MQTT Topic to publish to [string]
  2. Payload : Message to send [string]

Subscribe

MQTT.Subscribe
Subscribe to additional topics, beyond the one defined in the plugin options.

Example <Topic>:
VoxCommando/#

This will subscribe to all topics that start with VoxCommando/

  • Parameters: 1
  1. Topic : Topic to subscribe to [string]

Happy

GetBeaconInfo

MQTT.Happy.GetBeaconInfo


  • Parameters: 1
  1. Mac or Name : Name of beacon [string]

GetBeaconZone

MQTT.Happy.GetBeaconZone


  • Parameters: 1
  1. Mac or Name : Name of beacon [string]

GetZoneOccupants

MQTT.Happy.GetZoneOccupants
Returns a list of beacon names as matches, one for each beacon currently in the zone named <Zone>.

If the zone is empty, it returns 0 matches and an action error.

  • Parameters: 1
  1. Zone : Name of zone to query [string]