@micropede/mixins/mqtt-messages.js

Micropede Mixins

/* Mixins for Mqtt Messages */
const MqttMessages = new Object();

MqttMessages.onStateMsg = function(sender, val, method){
  return this.addSubscription(`${this.appName}/${sender}/state/${val}`, method);
}
MqttMessages.bindStateMsg = function(val, event, persist=true) {
  /* Notify plugins that state has successfully been modified */
  return this.addBinding(`${this.appName}/${this.name}/state/${val}`, event, persist);
}
MqttMessages.onStateErrorMsg = function(sender, val, method){
  return this.addSubscription(`${this.appName}/${sender}/error/${val}`, method);
}
MqttMessages.bindStateErrorMsg = function(val, event){
  /* Notify plugins upon failure to change state */
  return this.addBinding(`${this.appName}/${this.name}/error/${val}`, event);
}
MqttMessages.onPutMsg = function(val, method){
  return this.addSubscription(`${this.appName}/put/${this.name}/${val}`, method);
}
MqttMessages.bindPutMsg = function(receiver, val, event){
  /* Request plugin to change the state of one of its variables */
  return this.addBinding(`${this.appName}/put/${receiver}/${val}`, event);
}
MqttMessages.onNotifyMsg = function(sender,topic, method){
  return this.addSubscription(`${this.appName}/${sender}/notify/${this.name}/${topic}`, method);
}
MqttMessages.bindNotifyMsg = function(receiver, topic, event){
  /* Similar to trigger; notify plugin regarding a particular topic */
  return this.addBinding(`${this.appName}/${this.name}/notify/${receiver}/${topic}`, event);
}
MqttMessages.onStatusMsg = function(sender, method){
  return this.addSubscription(`${this.appName}/status/${sender}`, method);
}
MqttMessages.bindStatusMsg = function(event){
  /* Broadcast plugin status */
  return this.addBinding(`${this.appName}/status/${this.name}`, event);
}
MqttMessages.onTriggerMsg = function(action, method){
  return this.addSubscription(`${this.appName}/trigger/${this.name}/${action}`, method);
}
MqttMessages.bindTriggerMsg = function(receiver, action, event){
  /* Trigger another plugin to perform an action */
  return this.addBinding(`${this.appName}/trigger/${receiver}/${action}`, event);
}
MqttMessages.onSignalMsg = function(sender, topic, method){
  return this.addSubscription(`${this.appName}/${sender}/signal/${topic}`, method);
}
MqttMessages.bindSignalMsg = function(topic, event){
  /* Signal other plugins about a topic (without knowledge of those plugins)*/
  return this.addBinding(`${this.appName}/${this.name}/signal/${topic}`, event);
}

if (typeof module !== 'undefined' && module.exports) {
  // Check if being loaded from webpage, or as npm package
  module.exports = MqttMessages;
}