Skip to content

Supplemental stuff for using ScriptCraft with MQTT (protocol for network-connected arduinos)

License

Notifications You must be signed in to change notification settings

walterhiggins/scriptcraft-extras-mqtt

Repository files navigation

scriptcraft-extras-mqtt

Supplemental stuff for using ScriptCraft with MQTT (protocol for network-connected arduinos).

This repository adds MQTT support to ScriptCraft. It should be used in conjunction with ScriptCraft and is not a replacement for ScriptCraft.

To Use

The sc-mqtt.jar file which this project builds must be included in the classpath when starting up bukkit. (You can download the library from http://scriptcraftjs.org/download/extras/mqtt/ ) Copy the sc-mqtt.jar file into the craftbukkit directory. The craftbukkit server must be started like this (on Linux)...

java -cp sc-mqtt.jar:craftbukkit.jar org.bukkit.craftbukkit.Main

... on Windows, use the following command...

java -cp sc-mqtt.jar:craftbukkit.jar org.bukkit.craftbukkit.Main

... (the path separator character is different on each operating system, it's : on linux and ; on windows )

Once started in this way, you can connect to an MQTT broker using the following code...

var mqtt = require('sc-mqtt');
var client = mqtt.client('tcp://localhost:1883','exampleClient');
client.connect({
      keepAliveInterval: 10000
      });                
client.publish('scriptcraft','loaded');
client.subscribe('arduino');

// callback to use if you want to receive and handle messages
client.onMessageArrived(function(topic, message){
   // handle incoming messages here.
   var bytes = message.payload;
});
// the following callbacks are optional 
client.onDeliveryComplete(function(deliveryToken){
   // optional callback to handle completion of outgoing messages
   // (message ACK'd by receiver)
});
client.onConnectionLost(function(cause){
   // optional callback to handle connection loss
});

You will need to grab a version of ScriptCraft from 2014-01-17 or later here http://scriptcraftjs.org/download if you don't want to build from source. sc-mqtt uses the Eclipse Paho MQTTV3 Client library.

Example - publishing a MQTT message when a minecraft block is broken...

var mqtt = require('sc-mqtt');
var client = mqtt.client(); // default is localhost 1883
client.connect();
events.on('block.BlockBreakEvent', function (listener, event){
    client.publish('minecraft',  // topic
                   'blockbreak', // payload
                   1,            // QoS (1 is send at least once) 
                   true );       // broker should retain message
});

For details of the message object received in the messageArrived callback see ...

http://git.eclipse.org/c/paho/org.eclipse.paho.mqtt.java.git/tree/org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/MqttMessage.java

About

Supplemental stuff for using ScriptCraft with MQTT (protocol for network-connected arduinos)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages