To receive data from cloud, we need to implement callback function, which is called automatically and depends on the device connection. It helps you to get the device command from Cloud to Device and perform a predefined action.<\/p>\n
Once Init() is executed successfully, the device will be able to start publishing telemetry data using the SDK. Based on Init cached data, the SDK needs to make secure MQTT connection with message broker to send data. Before sending the data, make sure that the particular device is active using the web admin. Send data method uses the predefined data format which is explained in the next point.<\/p>\n
After initializing the \/IOTCONNECT\u2122 SDK instance, you can get the list of sensors which are predefined in the \/IOTCONNECT\u2122 platform. You can send the predefined sensor data in the templates only while other data may be ignored during send data process.<\/p>\n
Device twins are implicitly created and deleted when a device identity is created or deleted in IoT Hub. This is used along with reported properties to synchronize device configuration or conditions. The solution back end can set desired properties and the device app can read them. The device app can also receive notifications of changes in the desired properties. You can update the reported attribute using this method.<\/p>\n
This method is used to send the acknowledgement to the cloud. While getting the firmware command you need to send the confirmation message to the cloud that the firmware upgrade resource URL has successfully reached the device.<\/p>\n
Preferable Sensor Data Input<\/h3>\n[{\r\n \"uniqueId\": \"123456\",\r\n \"time\" : '2018-05-24T10:06:17.857Z', \/\/Date format should be in UTC timezone\r\n \"data\": {\r\n \"temperature\": 15.55,\r\n \"humidity\" : 27.97,\r\n \"weight\" : 36,\r\n \"gyroscope\" : {'x' : -1.2, 'y' : 0.25,'z' : 1.1, }\r\n }\r\n }];<\/pre>\n Explanation:<\/strong><\/p>\n uniqueId<\/em><\/strong>: It is the device uniqueID<\/em><\/p>\n time<\/em><\/strong>: Current date and time with UTC timezone<\/em><\/p>\n data<\/em><\/strong>: Set a JSON data with sensor name and value as per the device generated the data. Make sure you set the all required sensor name in device template as explained in the prerequisite step.<\/em><\/p>\nOTA Update And Command<\/h3>\n
To receive data from the Cloud, we need to implement a callback<\/em><\/strong> function, which is called automatically and depends on the device connection. It helps you to get the device command from Cloud to device and perform a predefined action.<\/p>\n![\"\"](\"https:\/\/knowledgebase.iotconnect.io\/wp-content\/uploads\/2019\/11\/graphic1.png\")
<\/p>\n
Here, we provide two types of devices to Cloud command. You can receive command from callback<\/em><\/strong> function which name is \u201ccallbackMessage<\/strong>\u201d. It has placed in the device initialization method. You need to write the firmware in a way that you can receive the command which is sent by the Cloud and take action.\u00a0 Command is received in the form JSON data, in which you get the key name \u201ccmdType<\/em><\/strong>\u201d with value in the form of hexa<\/em><\/strong> decimal<\/strong><\/em> which is as under:<\/p>\nCommand Format<\/strong><\/p>\n{\r\n\r\n\u00a0 \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"cpid\": \"<<your cp id>>\",\r\n\u00a0 \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"cmdType\": \"0x01\", \/\/ different command type for manage OTA and Command\r\n \"ack\": false,\r\n\u00a0 \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"command\": \"<<your command name>>\",\r\n\u00a0 \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"uniqueId\": \"<<your device id>>\",\r\n\u00a0 \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"ackId\": \"<<system guid>>\",\r\n\u00a0 \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"guid\": \"<<system guid>>\"\r\n\r\n}<\/pre>\n\n- 0x01 (Device Action Command) :<\/strong><\/li>\n<\/ol>\n
– It hleps to take action on any sensor.<\/p>\n
Example: “command”: “MOTOR-OFF”,<\/em><\/strong><\/p>\n– After command is received, firmware will take care of what to do with the command.<\/p>\n
\n- 0x02 (OTA Update Command) :<\/strong><\/li>\n<\/ol>\n
– It helps to get the below command:<\/p>\n
Example: “ota <<Firmware File URL>>”, <\/em><\/strong><\/p>\n– It helps to download the updated version of SDK and install it.<\/p>\n
– At the same time, you need to send the acknowledgement of the received message to the Cloud. For that, you need to publish the message with message type acknowledgement (11). It helps IoT Cloud to get the confirmation of the success of firmware package sent.<\/p>\n
– To send acknowledgement you need to follow the below method:<\/p>\n
msgType =\u00a0 11\r\nd2cMsg = {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"guid\" : data['guid'],\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"st\" : 3,\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"msg\" : \"\"\r\n}\r\nsdk.SendACK(msgType, d2cMsg)<\/pre>\n– After acknowledgement is received, the firmware will take care of this command and decide how to download the file URL.<\/p>\n
<\/p>\n<\/div>\n
Code Samples<\/h3>\n
The Web API can be easily used in C#, Java, Python, or any other development tools supporting communication over the network. \/IOTCONNECT\u2122 SDK provides a set of samples in different programming languages showing how to create a simple client application.<\/p>\n
\n- JavaScript (Node.js)<\/li>\n
- Java<\/li>\n
- Python<\/li>\n
- iOS<\/li>\n
- Objective-C<\/li>\n
- Android<\/li>\n
- DOT NET (C#)<\/li>\n<\/ul>\n
\n
JavaScript (Node.Js)<\/h3>\n
Prerequisite tools:<\/strong><\/p>\n\n- NodeJs : Node version v8.9.1 and compatible<\/li>\n
- Npm : NPM is compatible to the node version 5.5.1<\/li>\n<\/ol>\n
Installation\u00a0<\/strong><\/p>\n\n- Extract the \u201ciotconnect\u2013<\/strong>sdk-node-v1.0.0.zip<\/strong>\u201c<\/li>\n
- To install the required libraries use the below command:\n
\n- Go to SDK directory path using terminal\/Command prompt<\/li>\n
- cd\u00a0iotconnect-sdk\/<\/em><\/li>\n
- npm\u00a0install<\/em><\/li>\n<\/ul>\n<\/li>\n
- Copy the SDK source code(\/IOTCONNECT\u2122SDK<\/em>) into node_modules directory\n
\n- cd iotconnect\u2013<\/em>sdk\/node_modules\/<\/em><\/li>\n<\/ul>\n<\/li>\n
- You can take the sample file from the\u00a0\/IOTCONNECT\u2122SDK<\/em>\u00a0library and put on project root path.\n
\n- Source path : cd iotconnect-sdk\/node_modules\/\/IOTCONNECT\u2122SDK\/sample<\/li>\n
- Destination path : cd iotconnect-sdk\/sample<\/li>\n<\/ul>\n<\/li>\n
- Using terminal\/command prompt, go to the sample folder.\n
\n- cd iotconnect-sdk\/sample<\/li>\n<\/ul>\n<\/li>\n
- Ready to go:\n
\n- \/\/This script can send the data to given input(uniqueid, cpid) device by command prompt.<\/li>\n
- node example.js\u00a0<><\/em>\u00a0\/\/Environment DEV, QA, POC, PROD \u2013 (Default if not supply the environment argument)<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n
Usage<\/strong><\/p>\n Declare \/IOTCONNECT\u2122 SDK which is placed in node_modules directory.<\/p>\n
var sdk = require('\/IOTCONNECT\u2122SDK');\r\n <\/pre>\n Prerequisite input data<\/p>\n
var uniqueId = <<uniqueId>>; \r\n var cpid = <<CPID>>; \r\n var env = <<env>>; \/\/ DEV, QA, POC, AVNETPOC, PROD(Default)\r\n <\/pre>\n To get the device information and connect to the device<\/p>\n
var iotConnectSDK = new sdk(cpid, uniqueId, callbackMessage, twinCallbackMessage, env);\r\n <\/pre>\n To receive the command from Cloud to Device(C2D)<\/p>\n
var callbackMessage = function callbackMessage(data){\r\n console.log(data);\r\n }var iotConnectSDK = new sdk(cpid, uniqueId, callbackMessage);\r\n <\/pre>\n To receive the twin from Cloud to Device(C2D)<\/p>\n
var twinCallbackMessage = function twinCallbackMessage(data){\r\n console.log(data); \r\n }\r\n <\/pre>\n To get the list of attributes<\/p>\n
iotConnectSDK.getAttributes(function(response){\r\n console.log(\"Attributed :: \"+ response); });\r\n <\/pre>\n To send the data from Device To Cloud(D2C)<\/p>\n
iotConnectSDK.SendData(sendTeledata);<\/pre>\n
\n- To configure the secure SSL\/x509 connection follow below step for CA or CA Selfsiged certificate\n
\n- Open file : otconnect-sdk\/\/IOTCONNECT\u2122SDK\/sample\/properties.json<\/li>\n
- Set SSL\/x509 certificate path for CA sign and Selfsign certificate as shown below<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
{\r\n \"certificate\" : { \r\n \"SSLKeyPath\" : \"<< file path >>\/key.pem\",\r\n \"SSLCertPath\" : \"<< file path >>\/cert.pem\",\r\n \"SSLCaPath\" : \"<< file path >>\/ca.cert.pem\"\r\n }\r\n }\r\n <\/pre>\n To update the Twin Property<\/p>\n
var key = \"firmware_version\";\r\n var value = \"4.0\";\r\n iotConnectSDK.UpdateTwin(key,value, function (response) {\r\n console.log(\"Twin update :: \",response);\r\n })<\/pre>\n Sample code <\/strong>
\n Download sample code from the below list. You need to follow the installation steps mentioned above to run the code.<\/p>\nJava<\/h3>\n
Prerequisite tools:<\/strong><\/p>\n\n- sdk-1.0-jar-with-dependencies.jar<\/li>\n
- Java 8 ( or above )<\/li>\n<\/ol>\n
Installation:<\/strong><\/p>\n\n- Extract the \u201ciotconnect-sdk-java-v1.0.0.zip\u201d<\/li>\n
- Ready to go:<\/li>\n<\/ol>\n
\/\/This script can send the data to given input (uniqueid, cpid) device by command prompt<\/p>\n
\n- java -jar sdk-1.0-jar-with-dependencies.jar<\/li>\n<\/ul>\n
Usage:<\/strong><\/p>\n Add library<\/p>\n
Put sdk-1.0-jar-with-dependencies.jar <\/em>file in build path<\/p>\n Prerequisite input data *<\/p>\n
uniqueId = <<uniqueId>>; cpid = <<CPID>>; \r\n env = <<env>>; \/\/ DEV, QA, POC, PROD(Default)\r\n <\/pre>\n Create class and implement Interface \u201cSDKCallback\u201d<\/p>\n
public class JavaSDKClient implements SDKCallback { \r\n }\r\n <\/pre>\n To get the device information and connect to the device<\/p>\n
\r\n \/IOTCONNECT\u2122SDK ioTConnectSDK = new \/IOTCONNECT\u2122SDKImpl(cpId, uniqueId ,env, callerClassObject);\r\n <\/pre>\n Implement method to receive the command from Cloud to Device(C2D)<\/p>\n
public void sdkCallbackMethod(CloudResponse cloudResponse) {\r\n if(cloudResponse!=null) {\r\n System.out.println(\"ACK : \" + cloudResponse.getAck());\r\n System.out.println(\"ACK ID : \" + cloudResponse.getAckId());\r\n System.out.println(\"Command : \" + cloudResponse.getCommand());\r\n System.out.println(\"UniqueId : \" + cloudResponse.getUniqueId());\r\n System.out.println(\"Value : \" + cloudResponse.getValue());\r\n }\r\n }\r\n <\/pre>\n To send the data from Device To Cloud(D2C)<\/p>\n
ioTConnectSDK.SendData(sendTeledata)\r\n <\/pre>\nPython<\/h3>\n
Prerequisite tools:<\/strong><\/p>\n\n- Python: Python version 2.7, 3.6 and 3.7<\/li>\n
- pip: pip is compatible to the python version<\/li>\n
- setuptools: Required to install IOTConnect SDK<\/li>\n<\/ol>\n
Installation for Python version 2.7:<\/strong><\/p>\n\n- Extract the “iotconnect-sdk-python-v1.0.0.zip”<\/li>\n
- To install the required libraries, use the command given below:\n
\n- Goto SDK directory path using terminal\/Command prompt<\/li>\n
- cd iotconnect-sdk\/<\/li>\n
- pip install iotconnect-sdk-2.0.tar.gz<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n
\n- Using terminal\/command prompt goto sample folder:\n
\n- cd iotconnect-sdk\/sample<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n
\n- Ready to go: \/\/This script can send the data to given input(uniqueid, cpid) device by command prompt\n
\n- python example_py2.py <> \/\/Environment DEV, QA, POC, AVNETPOC, PROD (Default if not supply the environment argument)<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n
Usage:<\/strong><\/p>\nImport library<\/p>\n
from \/IOTCONNECT\u2122SDK import \/IOTCONNECT\u2122SDK\r\n<\/pre>\nPrerequisite input data<\/p>\n
uniqueId = <<uniqueId>> \r\ncpid = <<CPID>> \r\nenv = <<env>> \/\/ DEV, QA, POC, AVNETPOC, PROD(Default)\r\n<\/pre>\nTo get the device information and connect to the device<\/p>\n
with \/IOTCONNECT\u2122SDK(cpid, uniqueId, callbackMessage, callbackTwinMessage, env) as sdk:\r\n<\/pre>\nTo receive the command from Cloud to Device(C2D)<\/p>\n
def callbackMessage(msg):\r\nprint(msg)\r\n<\/pre>\nTo receive the twin from Cloud to Device(C2D)<\/p>\n
def callbackTwinMessage(msg):\r\nprint(msg)\r\n<\/pre>\nTo get the list of attributes<\/p>\n
sdk.GetAttributes()\r\n<\/pre>\nTo send the data from Device To Cloud(D2C)<\/p>\n
sdk.SendData(sendTeledata)\r\n<\/pre>\nTo update the Twin Property<\/p>\n
key = \"firmware_version\"\r\nvalue = \"4.0\"\r\nsdk.UpdateTwin(key, value)\r\n<\/pre>\n
\n- To configure the secure SSL\/x509 connection follow below step for CA or CA Selfsiged certificate<\/li>\n
- Open file : sample\/properties.json<\/li>\n
- Set SSL\/x509 certificate path for CA sign and Selfsign certificate as shown below<\/li>\n<\/ul>\n
{\r\n \"certificate\" : { \r\n \"SSLKeyPath\" : \"<< file path >>\/key.pem\",\r\n \"SSLCertPath\" : \"<< file path >>\/cert.pem\",\r\n \"SSLCaPath\" : \"<< file path >>\/ca.cert.pem\"\r\n }\r\n}<\/pre>\nTo send the Firmware update command acknowledgment.<\/p>\n
msgType = 11\r\nd2cMsg = {\r\n\"guid\" : << GUID >>, \/\/ GUID get from the received command\r\n\"st\" : 3, \/\/ STATUS :: Skipped = 2,Success = 3,Failed = 4\r\n\"msg\" : \"\"\r\n}\r\nsdk.SendACK(msgType, d2cMsg)<\/pre>\niOS<\/h3>\n
Prerequisite tools:<\/strong><\/p>\n\n- Xcode : Minimum iOS 10.0 Compatible<\/li>\n<\/ol>\n
Installation:<\/strong><\/p>\n\n- Get the “\/IOTCONNECT\u2122.framework” and add in framework in iOS App Project<\/li>\n<\/ol>\n
Usage:<\/strong><\/p>\nImport iOS library<\/p>\n
#import <\/IOTCONNECT\u2122\/\/IOTCONNECT\u2122SDK.h><\/pre>\n
\n- Objective-C *<\/li>\n<\/ul>\n
Define SDK object<\/p>\n
\/IOTCONNECT\u2122SDK *objectIoTSDK;<\/pre>\nSDK Init Call<\/p>\n
NSString *uniqueId=@\"sdk001\";\r\nNSString *cpId=@\"abcde1\";\r\nNSString *strEnv=@\"poc\u201d;\/\/ DEV , STAGE , poc , QA , PROD \r\nobjectIoTSDK =[[\/IOTCONNECT\u2122SDK alloc] init: cpId : uniqueId : strEnv :^(id message) {\r\n \/* Handle Cloud to Device message *\/\r\n}];<\/pre>\nSend sensor data call format<\/p>\n
var data=[[\r\n\"uniqueId\": \"sdk001\",\r\n\"time\": \"2018-03-08T15:13:13.573Z\",\r\n\"data\": [\"temperature\": \"45\u201d,\"humidity\": \"40\"]\r\n]]\r\nSend Temperature and Humidity\r\nobject\/IOTCONNECT\u2122.sendData(data)NSArray *data=@[@{\r\n @\"uniqueId\":@\"sdk001\",\r\n @\"time\":@\"2018-03-06T11:38:53.000Z\",\r\n @\"data\":@{@\"temperature\":@\"45\",@\"humidity\":@\"40\"\r\n }\r\n}];<\/pre>\nSend Temperature and Humidity<\/p>\n
object\/IOTCONNECT\u2122.sendData(data)<\/pre>\nObjective-C<\/h3>\n
Prerequisite tools:<\/strong><\/p>\n\n- Arduino IDE 1.6.5 or higher<\/li>\n
- ESP8266 \/ ESP32 boards installed<\/li>\n<\/ol>\n
Installation:<\/strong><\/p>\n\n- Extract the “ESP32.zip” or “ESP8266.zip” from sdk<\/li>\n
- To install the required libraries, use the below command:\n
\n- Get help from the documentation file<\/li>\n<\/ul>\n<\/li>\n
- Ready to go:\n
\n- This script can send the data to given input(uniqueid, cpid, WiFi information)<\/li>\n
- Environment DEV, QA, POC, AVNETPOC, PROD – (Default – AVNET if the environment argument is not supplied)<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
Usage:<\/strong><\/p>\nIncluding the libraries (from the zip file)<\/p>\n
#include \"\/IOTCONNECT\u2122.h\" \/\/ Connection with \/IOTCONNECT\u2122 and other process\r\n#include \"time.h\" \/\/ getting real time from NTP server\r\n<\/pre>\nDefine SDK object<\/p>\n
IOTConnectClient client;<\/pre>\nPrerequisite input data<\/p>\n
String ENV = \"AVNET\";\r\nString VER = \"2.0\";\r\nchar *ssid = \"yourNetwork\"; \/\/ your network SSID (name)\r\nchar *pass = \"secretPassword\"; \/\/ your network password )\r\nString cpId = \"yourCpid\"; \/\/ your CPID name can grab it from \/IOTCONNECT\u2122 portal\r\nString uniqueID = \"yourUniqueID\"; \/\/ you can grab it from \/IOTCONNECT\u2122 portal\r\n<\/pre>\nTo get the device information and connect to the device<\/p>\n
client.InitializationSDK(cpId, uniqueID, ENV, VER);\r\n\/\/ initialization SDK for \/IOTCONNECT\u2122<\/pre>\nTo receive the command from Cloud to Device(C2D)<\/p>\n
void messageReceived(String &topic, String &payload) { \/\/ callback function\r\nSerial.println(\"incoming >> \" + payload); \/\/ broker on subscribed topic\r\n}<\/pre>\nData input format<\/p>\n
DynamicJsonBuffer jsonBufferIN;\r\nJsonArray& Device_data= jsonBufferIN.createArray();\r\nJsonObject& Device_01= Device_data.createNestedObject();\r\nDevice_01[\"uniqueId\"] = uniqueID;\r\nDevice_01[\"time\"] = GetTime();\r\nJsonObject& D01_Sensors=Device_01.createNestedObject(\"data\");\r\nD01_Sensors[\"humidity\"] = random(20, 80);\r\nD01_Sensors[\"Temperature\"] = random(12, 32);\r\nJsonObject& D01_SensorsX= D01_Sensors.createNestedObject(\"Vibration\");\r\nD01_SensorsX[\"x\"] = random(12, 50);\r\nD01_SensorsX[\"y\"] = random(-20, 30);\r\nD01_SensorsX[\"z\"] = random(10, 35);\r\nDevice_data.printTo(DataBuffer, sizeof(DataBuffer));\r\n<\/pre>\nTo send the data from Device To Cloud(D2C)<\/p>\n
client.SendDataINput(DataBuffer);<\/pre>\nTo update the Twin Property<\/p>\n
String key = \"firmware_version\";\r\nString value = \"4.0\";\r\nclient.UpdateTwin(key,value);\r\n<\/pre>\nSample code <\/strong>
\nDownload sample code from the below list. You need to follow the installation steps mentioned above to run the code.<\/p>\nAndroid<\/h3>\n
Prerequisite tools:<\/strong><\/p>\n\n- Java 8 (or above)<\/li>\n
- Android SDK<\/li>\n
- Android Studio<\/li>\n<\/ol>\n
Installation:<\/strong><\/p>\n1. Please verify jcenter in your root build.gradle at the end of repositories:<\/p>\n
allprojects { repositories {\r\n ... jcenter()\r\n }\r\n}<\/pre>\n2. Add the dependency<\/p>\n
dependencies {\r\n implementation 'com.iotconnectsdk:iotconnectpoc:2.0.0'\r\n \r\n}<\/pre>\nUsage:<\/strong><\/p>\nAdd library<\/p>\n
Prerequisite input data<\/p>\n
uniqueId = <<uniqueId>>; cpid = <<CPID>>; env = <<env>>;\r\n\/\/ DEV, QA, POC, AVNETPOC, PROD(Default)<\/pre>\nCreate class and implement Interface “IotSDKCallback”<\/p>\n
public class JavaSDKClient implements IotSDKCallback { \r\n}<\/pre>\nTo get the device information and connect to the device<\/p>\n
\/IOTCONNECT\u2122SDK ioTConnectSDK = new \/IOTCONNECT\u2122SDK(context,cpid,uniqueId, callerClassObject,env);<\/pre>\nImplement methods to receive the command from Cloud to Device(C2D)<\/p>\n
public void onReceiveMsg( HubToSdkDataBean cloudResponse) { if(cloudResponse!=null) {\r\n System.out.println(\"ACK : \" + cloudResponse.getAck());\r\n System.out.println(\"ACK ID : \" + cloudResponse.getAckid());\r\n System.out.println(\"Command : \" + cloudResponse.getCommand());\r\n System.out.println(\"UniqueId : \" + cloudResponse.getUniqueid());\r\n System.out.println(\"Value : \" + cloudResponse.getValue());\r\n }\r\n}<\/pre>\nGet attributesList<\/p>\n
public void attributeData(final List<SyncServiceResponse.DBeanXX.AttBean>\r\nattributesBeanList) { }<\/pre>\nGet connection status<\/p>\n
public void onConnectionStateChange(boolean isConnected) { \r\n}<\/pre>\nTo send the data from Device To Cloud(D2C)<\/p>\n
ioTConnectSDK.SendData(sendTeledata)<\/pre>\nDisconnect iotConnect on Activtiy onDestroy<\/p>\n
@Override\r\n protected void onDestroy() { super.onDestroy(); if(iotConnect!=null)\r\n {\r\n ioTConnectSDK.disconnectSDK();\r\n }\r\n }<\/pre>\nSample code <\/strong>
\nDownload sample code from the below list. You need to follow the installation steps mentioned above to run the code.<\/p>\nDOT NET (C#)<\/h3>\n
Prerequisite tools:<\/strong><\/p>\n\n- NET Core 2.0<\/li>\n<\/ol>\n
Installation:<\/strong><\/p>\n\n- Open Visual Studio 2017, Create new .net core Console App<\/li>\n
- Create new folder called Nuget and place IOTConnect SDK Nuget package<\/li>\n
- Open Nuget Package Manager of Console App and click on Setttings for Package source<\/li>\n
- Add new Package source, name it as LocalPackage and in source give path of Nuget folder created in step #2<\/li>\n<\/ol>\n
Usage:<\/strong><\/p>\nIn Program.cs add namespace of IOTConnect SDK<\/p>\n
using IOTConnectSDK;<\/pre>\nCreate object of SDKClient<\/p>\n
string cpId = \"\", uniqueId = \"\";\r\nSDKClient client = new SDKClient(cpId, uniqueId, FirmwareDelegate, TwinUpdateCallBack);<\/pre>\nCallback function to receive Cloud to Device message (C2D)<\/p>\n
public static Task FirmwareDelegate(string message)\r\n{\r\n Console.WriteLine(\"Command Received.\");\r\n Console.WriteLine(message);\r\n return Task.CompletedTask;\r\n}<\/pre>\nCallback function to receive twin update<\/p>\n
public static Task TwinUpdateCallBack(Dictionary<string, object> twins)\r\n{\r\n Console.WriteLine(\"Twin Update received.\");\r\n foreach (var twin in twins)\r\n {\r\n Console.WriteLine($\"{twin.Key}:{twin.Value}\");\r\n }\r\n return Task.CompletedTask;\r\n}<\/pre>\nSample data<\/p>\n
[{\r\n \"cpId\": \"\", \/\/CPID of company\r\n \"time\": \"\", \/\/Datetime Fromat: YYYY-MM-DDTHH:MM:SS.SSSSSSSS\" \r\n \"uniqueId\": \"\", \/\/Device ID\r\n \"d\": [{ \/\/Telemetry data\r\n \"voltage\": 143.0,\r\n \"current\": 4.0,\r\n \"frequency\": 6.10,\r\n \"brewing\": false,\r\n \"product\": null,\r\n \"size\": null,\r\n \"device\": \"off\"\r\n }\r\n ]\r\n }\r\n]<\/pre>\nTo send the data from Device To Cloud(D2C)<\/p>\n
client.SendData(File.ReadAllText(@\"devicedata.json\"));<\/pre>\nTo configure the secure SSL\/x509 connection follow below step for CA or CA Selfsiged certificate<\/p>\n
\n- Open file : iotconnect-sdk\/\/IOTCONNECT\u2122SDK\/sample\/properties.json<\/li>\n
- Set SSL\/x509 certificate path for CA sign and Selfsign certificate as shown below<\/li>\n<\/ul>\n
SDKClient.SSL.Certificate = certiPath;\r\nSDKClient.SSL.Password = certiPass;<\/pre>\nTo update the Twin Property<\/p>\n
client.UpdateTwin(\"twin-property\",\"new value\");<\/pre>\nSample code <\/strong>
\nDownload sample code from the below list. You need to follow the installation steps mentioned above to run the code.<\/p><\/div>\nDevice Command<\/h3>\n
To receive data from the cloud, we need to implement a callback<\/em><\/strong> function, which is called automatically and depends on the device connection. It helps you to get the device command from Cloud to Device and perform a predefined action.<\/p>\nHere, we provide two types of devices to cloud command. You can receive command from callback<\/strong><\/em> function which name is \u201ccallbackMessage\u201d.<\/strong> It is placed in the device initialization method. You need to write the firmware in a way that you can receive the command which was sent by the cloud and take further action. Command will be received in the form JSON data, in which you get the key name \u201ccmdType\u201d<\/strong> with a value in the form of hexadecimal,<\/strong> which is as under:<\/p>\n
![\"\"](\"https:\/\/knowledgebase.iotconnect.io\/wp-content\/uploads\/2019\/06\/Create-Template-Attributes-1-2.png\")
<\/p>\n![\"\"](\"https:\/\/knowledgebase.iotconnect.io\/wp-content\/uploads\/2019\/06\/create-device-1-1.png\")
<\/p>\n![\"\"](\"https:\/\/knowledgebase.iotconnect.io\/wp-content\/uploads\/2019\/06\/Device-Details-_-Edit-Mode_Type2-1.png\")
<\/p>\n![\"\"](\"https:\/\/knowledgebase.iotconnect.io\/wp-content\/uploads\/2019\/06\/Batch-Import-List-1.png\")
<\/p>\n![\"\"](\"https:\/\/knowledgebase.iotconnect.io\/wp-content\/uploads\/2019\/06\/Diagram-01-e1562072973390-1.png\")
<\/p>\n