Merge branch 'yun-client'

Author: 256dpi

.gitignore

@@ -2,3 +2,4 @@
 build/
 node_modules/
 mqtt.zip
+yun/.idea

CMakeLists.txt

@@ -3,7 +3,8 @@
 cmake_minimum_required(VERSION 2.8.4)
 project(arduino_mqtt)
 
-include_directories(/Applications/Arduino.app/Contents/Resources/Java/hardware/arduino/avr/cores/arduino)
+include_directories(/Applications/Arduino.app/Contents/Java/hardware/arduino/avr/cores/arduino/)
+include_directories(/Applications/Arduino.app/Contents/Java/libraries/Bridge/src)
 
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
 
@@ -30,6 +31,12 @@ set(SOURCE_FILES
     src/Network.cpp
     src/Network.h
     src/Timer.cpp
-    src/Timer.h)
+    src/Timer.h
+    src/YunMQTTClient.cpp
+    src/YunMQTTClient.h
+    src/YunMQTTInstall.cpp
+    src/YunMQTTInstall.h
+    examples/MQTTClient/MQTTClient.ino
+    examples/YunClientInstall/YunClientInstall.ino)
 
 add_executable(arduino_mqtt ${SOURCE_FILES})

README.md

@@ -1,8 +1,8 @@
 # arduino-mqtt
 
-**paho mqtt library wrapper for arduino**
+**MQTT library for arduino based on the Eclipse Paho projects*
 
-This library bundles the [Embedded MQTT C/C++ Client](https://eclipse.org/paho/clients/c/embedded/) library of the eclipse paho project and adds a thin wrapper to get an Arduino like API.
+This library bundles the [Embedded MQTT C/C++ Client](https://eclipse.org/paho/clients/c/embedded/) library of the Eclipse Paho project and adds a thin wrapper to get an Arduino like API. Additionally there is an drop-in alternative for the Arduino Yùn that uses a python based client on the linux processor and a binary interface to lower resources usage on the Arduino side.
 
 The first release of the library only supports QoS0 and the basic features to get going. In the next releases more of the features will be available.
 
@@ -16,52 +16,8 @@ This library is an alternative to the [pubsubclient](https://github.com/knollear
 
 This library has been only tested on the **Arduino Yùn** yet. Other boards and shields should work if they properly extend the Client API.
 
-## Example
+## Examples
 
-```c++
-#include <Bridge.h>
-#include <YunClient.h>
-#include <MQTTClient.h>
-
-YunClient net;
-MQTTClient client("connect.shiftr.io", 1883, net);
-
-unsigned long lastMillis = 0;
-
-void setup() {
-  Bridge.begin();
-  Serial.begin(9600);
-  Serial.println("connecting...");
-  if (client.connect("arduino", "demo", "demo")) {
-    Serial.println("connected!");
-    client.subscribe("/another/topic");
-    // client.unsubscribe("/another/topic");
-  } else {
-    Serial.println("not connected!");
-  }
-}
-
-void loop() {
-  client.loop();
-  // publish message roughly every second
-  if(millis() - lastMillis > 1000) {
-    lastMillis = millis();
-    client.publish("/topic", "Hello world!");
-  }
-}
-
-void messageReceived(String topic, String payload, char * bytes, unsigned int length) {
-  Serial.print("incomming: ");
-  Serial.print(topic);
-  Serial.print(" - ");
-  Serial.print(payload);
-  Serial.println();
-}
-```
-
-## Configuration
-
-```c++
-// this buffer gets allocated two times to hold the outgoing and incomming message
-#define MQTT_BUFFER_SIZE 64 // default 128
-```
+- [Example using the standard MQTTClient]().
+- [Example using the alternative YunMQTTClient]().
+- [Sketch to install the YunMQTTClient python client script]().

examples/PublishSubscribe/PublishSubscribe.ino renamed to examples/MQTTClient/MQTTClient.ino

@@ -0,0 +1,14 @@
+#include <Bridge.h>
+#include <YunMQTTInstall.h>
+
+void setup() {
+  Bridge.begin();
+  Serial.begin(9600);
+
+  while (!Serial);
+  delay(1000);
+
+  YunMQTTInstall();
+}
+
+void loop() {}

examples/YunClientInstall/YunClientInstall.ino

@@ -0,0 +1,36 @@
+#include <Bridge.h>
+#include <YunMQTTClient.h>
+
+YunMQTTClient client("connect.shiftr.io", 1883);
+
+unsigned long lastMillis = 0;
+
+void setup() {
+  Bridge.begin();
+  Serial.begin(9600);
+  Serial.println("connecting...");
+  if (client.connect("arduino", "demo", "demo")) {
+    Serial.println("connected!");
+    client.subscribe("/another/topic");
+    // client.unsubscribe("/another/topic");
+  } else {
+    Serial.println("not connected!");
+  }
+}
+
+void loop() {
+  client.loop();
+  // publish message roughly every second
+  if(millis() - lastMillis > 1000) {
+    lastMillis = millis();
+    client.publish("/topic", "Hello world!");
+  }
+}
+
+void messageReceived(String topic, String payload, char * bytes, unsigned int length) {
+  Serial.print("incomming: ");
+  Serial.print(topic);
+  Serial.print(" - ");
+  Serial.print(payload);
+  Serial.println();
+}

examples/YunMQTTClient/YunMQTTClient.ino

@@ -2,7 +2,7 @@ name=MQTT
 version=1.3.2
 author=Joel Gaehwiler <joel.gaehwiler@gmail.com>
 maintainer=Joel Gaehwiler <joel.gaehwiler@gmail.com>
-sentence=Paho MQTT library wrapper for Arduino.
-paragraph=This library bundles the Embedded MQTT C/C++ Client library of the eclipse paho project and adds a thin wrapper to get an Arduino like API.
+sentence=MQTT library for arduino based on the Eclipse Paho projects.
+paragraph=This library bundles the Embedded MQTT C/C++ Client library of the Eclipse Paho project and adds a thin wrapper to get an Arduino like API. Additionally there is an drop-in alternative for the Arduino Yùn that uses a python based client on the linux processor and a binary interface to lower resources usage on the Arduino side.
 url=https://github.com/256dpi/arduino-mqtt
 architectures=*

library.properties

@@ -42,46 +42,46 @@ boolean MQTTClient::connect(const char * clientId, const char * username, const
   return this->client->connect(data) == 0;
 }
 
-boolean MQTTClient::publish(String topic) {
-  return this->publish(topic.c_str(), "");
+void MQTTClient::publish(String topic) {
+  this->publish(topic.c_str(), "");
 }
 
-boolean MQTTClient::publish(String topic, String payload) {
-  return this->publish(topic.c_str(), payload.c_str());
+void MQTTClient::publish(String topic, String payload) {
+  this->publish(topic.c_str(), payload.c_str());
 }
 
-boolean MQTTClient::publish(const char * topic, String payload) {
-  return this->publish(topic, payload.c_str());
+void MQTTClient::publish(const char * topic, String payload) {
+  this->publish(topic, payload.c_str());
 }
 
-boolean MQTTClient::publish(const char * topic, const char * payload) {
+void MQTTClient::publish(const char * topic, const char * payload) {
   MQTT::Message message;
   message.qos = MQTT::QOS0;
   message.retained = false;
   message.dup = false;
   message.payload = (char*)payload;
   message.payloadlen = strlen(payload);
-  return client->publish(topic, message) == 0;
+  client->publish(topic, message);
 }
 
-boolean MQTTClient::subscribe(String topic) {
-  return this->subscribe(topic.c_str());
+void MQTTClient::subscribe(String topic) {
+  this->subscribe(topic.c_str());
 }
 
-boolean MQTTClient::subscribe(const char * topic) {
-  return client->subscribe(topic, MQTT::QOS0, NULL) == 0;
+void MQTTClient::subscribe(const char * topic) {
+  client->subscribe(topic, MQTT::QOS0, NULL);
 }
 
-boolean MQTTClient::unsubscribe(String topic) {
-  return this->unsubscribe(topic.c_str());
+void MQTTClient::unsubscribe(String topic) {
+  this->unsubscribe(topic.c_str());
 }
 
-boolean MQTTClient::unsubscribe(const char * topic) {
-  return client->unsubscribe(topic) == 0;
+void MQTTClient::unsubscribe(const char * topic) {
+  client->unsubscribe(topic);
 }
 
-boolean MQTTClient::loop() {
-  return this->client->yield() == 0;
+void MQTTClient::loop() {
+  this->client->yield();
 }
 
 boolean MQTTClient::connected() {

src/MQTTClient.cpp

@@ -27,15 +27,15 @@ class MQTTClient {
   MQTTClient(const char * hostname, int port, Client& client);
   boolean connect(const char * clientId);
   boolean connect(const char * clientId, const char* username, const char* password);
-  boolean publish(String topic);
-  boolean publish(String topic, String payload);
-  boolean publish(const char * topic, String payload);
-  boolean publish(const char * topic, const char * payload);
-  boolean subscribe(String topic);
-  boolean subscribe(const char * topic);
-  boolean unsubscribe(String topic);
-  boolean unsubscribe(const char * topic);
-  boolean loop();
+  void publish(String topic);
+  void publish(String topic, String payload);
+  void publish(const char * topic, String payload);
+  void publish(const char * topic, const char * payload);
+  void subscribe(String topic);
+  void subscribe(const char * topic);
+  void unsubscribe(String topic);
+  void unsubscribe(const char * topic);
+  void loop();
   boolean connected();
   void disconnect();
 };

src/MQTTClient.h

@@ -0,0 +1,118 @@
+#include "YunMQTTClient.h"
+
+YunMQTTClient::YunMQTTClient(const char * _hostname, int _port) {
+  this->hostname = _hostname;
+  this->port = _port;
+}
+
+boolean YunMQTTClient::connect(const char * clientId) {
+  return this->connect(clientId, "", "");
+}
+
+boolean YunMQTTClient::connect(const char * clientId, const char * username, const char * password) {
+  this->process.begin("python");
+  this->process.addParameter("-u");
+  this->process.addParameter("/usr/client.py");
+  this->process.runAsynchronously();
+  this->process.setTimeout(10000);
+
+  // wait for script to launch
+  this->process.readStringUntil('\n');
+
+  // send connect request
+  this->process.print("c:");
+  this->process.print(this->hostname);
+  this->process.print(':');
+  this->process.print(this->port);
+  this->process.print(':');
+  this->process.print(clientId);
+  if(strlen(username) > 0 && strlen(password) > 0) {
+    this->process.print(':');
+    this->process.print(username);
+    this->process.print(':');
+    this->process.print(password);
+  }
+  this->process.print('\n');
+
+  // wait for answer
+  String ret = this->process.readStringUntil('\n');
+  this->alive = ret.equals("ca");
+
+  if(!this->alive) {
+    this->process.close();
+    return false;
+  } else {
+    return true;
+  }
+}
+
+void YunMQTTClient::publish(String topic) {
+  this->publish(topic.c_str(), "");
+}
+
+void YunMQTTClient::publish(String topic, String payload) {
+  this->publish(topic.c_str(), payload.c_str());
+}
+
+void YunMQTTClient::publish(const char * topic, String payload) {
+  this->publish(topic, payload.c_str());
+}
+
+void YunMQTTClient::publish(const char * topic, const char * payload) {
+  // send publish request
+  this->process.print("p:");
+  this->process.print(topic);
+  this->process.print(':');
+  this->process.print(payload);
+  this->process.print('\n');
+}
+
+void YunMQTTClient::subscribe(String topic) {
+  this->subscribe(topic.c_str());
+}
+
+void YunMQTTClient::subscribe(const char * topic) {
+  // send subscribe request
+  this->process.print("s:");
+  this->process.print(topic);
+  this->process.print('\n');
+}
+
+void YunMQTTClient::unsubscribe(String topic) {
+  this->unsubscribe(topic.c_str());
+}
+
+void YunMQTTClient::unsubscribe(const char * topic) {
+  // send unsubscribe request
+  this->process.print("u:");
+  this->process.print(topic);
+  this->process.print('\n');
+}
+
+void YunMQTTClient::loop() {
+  int av = this->process.available();
+  if(av > 0) {
+    String ret = process.readStringUntil('\n');
+
+    if(ret.startsWith("m")) {
+      int startTopic = 2;
+      int endTopic = ret.indexOf(':', startTopic + 1);
+      int startPayload = endTopic + 1;
+      int endPayload = ret.indexOf(':', startPayload + 1);
+      String topic = ret.substring(startTopic, endTopic);
+      String payload = ret.substring(startPayload, endPayload);
+      messageReceived(topic, payload, (char*)payload.c_str(), payload.length());
+    } else if(ret.startsWith("e")) {
+      this->alive = false;
+    }
+  }
+}
+
+boolean YunMQTTClient::connected() {
+  return this->alive;
+}
+
+void YunMQTTClient::disconnect() {
+  // send disconnect request
+  this->process.print("d\n");
+}