Add ARTIK Cloud Websocket and MQTT demos (#15)

IoT.js-Samples-DCO-1.0-Signed-off-by: Daniel Balla [email protected]

Author: Daniel Balla

artik-cloud-mqtt/app.js

@@ -0,0 +1,62 @@
+/* Copyright 2018-present Samsung Electronics Co., Ltd. and other contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+var mqtt = require('mqtt');
+var tls = require('tls');
+
+var device_id = 'DEVICE ID';
+var device_token = 'DEVICE TOKEN';
+
+var clientOpts = {
+  port: 8883,
+  username: device_id,
+  password: device_token,
+  keepalive: 30,
+};
+
+function getMsg() {
+  var temperature = Math.round(Math.random() * 100);
+
+  return JSON.stringify({
+    "sdid": device_id,
+    "ts": Date.now(),
+    "type": "message",
+    "data": {
+      "temp": temperature
+    }
+  });
+}
+
+var publishCounter = 0;
+
+var client = mqtt.connect('mqtts://api.artik.cloud', clientOpts);
+
+function keepPublishing() {
+  setInterval(function() {
+    client.publish('/v1.1/messages/' + device_id, getMsg());
+    publishCounter++;
+
+    if (publishCounter == 10) {
+      clearInterval(this);
+      client.end();
+    }
+  }, 500);
+}
+
+client.on('connect', function() {
+  // Subscribe to the actions channel
+  client.subscribe('/v1.1/actions/' + device_id);
+  keepPublishing();
+});

artik-cloud-mqtt/readme.md

@@ -0,0 +1,29 @@
+# IoT.js MQTT Artik cloud demo
+This short demo demonstrates a connection to the `api.artik.cloud` server through an SSL connection.
+
+## Step 1 - Initial setup
+Register a new account on `https://developer.artik.cloud/` and sign in.
+Build IoT.js with MQTT and TLS enabled (`--cmake-param=-DENABLE_MODULE_MQTT=1 --cmake-param=-DENABLE_MODULE_TLS=1`).
+## Step 2 - Registering your device
+When signed in click on the `Devices` button. This will navigate you to the section where you can manage your devices.
+Add a new device clicking on `Add Another device...`
+Select a corresponding device, or if you don't find anything suitable you can create your own type of device, by clicking on the `Developers` button in the top right corner.
+Having clicked the button you will see a `Dashboard` where you can see `Device types` and you can click on `+ New` to create a new type of device.
+Select a display name and a unique name for your device. The unique name must be in the format `com.your_company.devicename`. Having that done, you can continue, and you will be redirected to the next page where you can set your device up. After selecting the correct device, you should give it a name and you are all set.
+## Step 3 - Filling in the credentials
+Click on the device, and a popup will show up. You should generate a device token as it is needed for the authentication. This will be your `password` property in the MQTT options object.
+Copy your `device ID` and `device token` to the corresponding values in the JS example file, generate a client certificate and a private key for example with `OpenSSL`, and also set it in the JS file.
+## Additional information
+According to the documentation the data you send must be `JSON.stringify`-d, and should be in the following format:
+```js
+var data = {
+    "data": {
+        "property_name": property_value,
+        ...
+    }
+}
+```
+**Note**: For some reason the Artik cloud currently only receives empty data object `{}`.
+
+Only one MQTT client can be connected with the same `device id` simultaneously.
+A client can `publish` and/or `subscribe` to a topic.

artik-cloud-websocket/app.js

@@ -0,0 +1,62 @@
+/* Copyright 2018-present Samsung Electronics Co., Ltd. and other contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+var ws = require('websocket');
+
+var websocket = new ws.Websocket();
+
+var device_id = "DEVICE ID";
+var device_token = "DEVICE TOKEN";
+
+function getTimeMillis(){
+	return parseInt(Date.now().toString());
+}
+
+function register() {
+  var reg_object = {
+    type: "register",
+    sdid: device_id,
+    Authorization: "bearer " + device_token,
+    cid: getTimeMillis(),
+  };
+  console.log('Sending register message ' + JSON.stringify(reg_object));
+  websocket.send(JSON.stringify(reg_object), {mask: true});
+}
+
+function sendTemp(temp) {
+  var data_object = {
+    sdid: device_id,
+    ts: getTimeMillis(),
+    data: {
+      temp: temp,
+    },
+    cid: getTimeMillis(),
+  };
+  console.log('Sending temperature data ' + JSON.stringify(data_object));
+  websocket.send(JSON.stringify(data_object), {mask: true});
+}
+
+websocket.on('message', function(msg) {
+  console.log('Received message: ' + msg);
+  var parsed_msg = JSON.parse(msg);
+});
+
+websocket.on('connect', function() {
+  console.log('Websocket connection is open ....');
+  register();
+  sendTemp(73);
+});
+
+websocket.connect('wss://api.artik.cloud', 443, '/v1.1/websocket?ack=true');

artik-cloud-websocket/readme.md

@@ -0,0 +1,18 @@
+# IoT.js WebSocket ARTIK Cloud demo
+
+## Step 1 - Initial setup
+Register a new account on `https://developer.artik.cloud/` and sign in.
+Build IoT.js with WebSocket and TLS enabled (`--cmake-param=-DENABLE_MODULE_WEBSOCKET=1 --cmake-param=-DENABLE_MODULE_TLS=1`).
+## Step 2 - Registering your device
+When signed in click on the `Devices` button. This will navigate you to the section where you can manage your devices.
+Add a new device clicking on `Add Another device...`
+Select a corresponding device, or if you don't find anything suitable you can create your own type of device, by clicking on the `Developers` button in the top right corner.
+Having clicked the button you will see a `Dashboard` where you can see `Device types` and you can click on `+ New` to create a new type of device.
+Select a display name and a unique name for your device. The unique name must be in the format `com.your_company.devicename`. Having that done, you can continue, and you will be redirected to the next page where you can set your device up. After selecting the correct device, you should give it a name and you are all set.
+## Step 2.1 (optional) - Setting up a manifest
+A manifest is needed if you have your own type of device set up. It basically handles the incoming data.
+When sending the `data` object, its fields must be the same as set up in the `manifest`.
+More info on: https://developer.artik.cloud/documentation/data-management/the-manifest.html
+## Step 3 - Filling in the credentials
+Click on the device, and a popup will show up. You should generate a device token as it is needed for the authentication.
+Copy your `device ID` and `device token` to the corresponding values in the JS example file.