grandeurdev / arduino-sdk Goto Github PK

We used Arduino_JSON in the SDK because of its simplicity and syntax similarity with that of javascript's JSON which makes it easy to understand and kind of consistent for multiple platforms. But I realized that ArduinoJson is better in terms of performance. Plus Arduino_JSON is still in beta stage which can make it vulnerable to bugs.

We have added two connection listeners i.e. Apollo Connection Listener, Apollo Disconnection Listener which isn't consistent with the JS SDK where there is a single listener called onConnection. So whenever state gets a change, we send CONNECTED or DISCONNECTED in the callback argument.
Secondly, this should be extended to send other events like related to WiFi.

Right now, we call subscriptions.on() right as we send subscription request message to Grandeur. The request could get rejected. Therefore, we should call it after we receive acknowledgement from Grandeur. For that, we can add a task which would schedule a function calling subscriptions.on(). This can be done using a lambda function.

But our Callback class doesn't accept a lambda functions as of now. So we need to redesign the Callback to accept lambda functions.

Update library name in library properties file.

In Datastore insert example there is a little issue. We have referenced insert without specifying collection name.

I've heard there's an async version of duplex too which can further remove the need of somethings we are doing, e.g., the update function that the user needs to call in loop() to keep updating the TCP buffer.

Following error occurs on compiling example 'HelloGrandeur-esp32':

arduino-sdk\src/EventEmitter/EventEmitter.h:14:8:

error: 'vector' in namespace 'std' does not name a template type

std::vector events;

Probably the same with every program.

Currently we have to go and set the debug flag to 1 to see these issues. Ideally these should be instantly returned as reason in project.onConnection handler.

It's in nature of device's duplex connection with the Grandeur Cloud which we can take to our advantage and shift the errors code checking into the library instead of letting the user handle them.

Every function (getSummary, setSumary, getParms, setParms) sends deviceID and some related data to the cloud. Since the deviceID is already validated while the establishment of connection, DEVICE-ID-INVALID error won't occur. The only other error that can occur is SERVER-ERROR which is a server-side error and client has nothing to do with it.

Therefore, we can easily do the these errors code handling in the library and return only the data after stripping off the code and message. This would minimize user's headache and make its development much more seamless.

Currently, device variables are only updated when the device calls set(), which it has to do in loop() to push updates onto Grandeur, which in most of the cases is redundant data. We can add a function to the SDK that watches a variable, and calls the underlying when an update occurs. Like a stream of data. A variable can be piped to its version on Grandeur.

This looks useful to me. Tell me your thoughts about it.

I have tried compiling the code and it gives following error.
PS: I have installed the libraries as instructed in the email.

Arduino: 1.6.5 (Windows 8.1), Board: "LOLIN(WEMOS) D1 mini Pro, 80 MHz, Flash, Disabled, All SSL ciphers (most compatible), 16M (14M SPIFFS), v2 Lower Memory, Disabled, None, Only Sketch, 921600"

C:\Users\Hasnain\Documents\Arduino\libraries\grandeurcloud-arduino-sdk-master\src\Duplex.cpp:26:18: fatal error: Hash.h: No such file or directory
#include <Hash.h>
^
compilation terminated.
Error compiling.

This report would have more information with
"Show verbose output during compilation"
enabled in File > Preferences.

In functions like getSummary the deviceID should be received directly in argument instead of first wrapping it in JSON object. That is the way we are receiving deviceID in JS SDK.

We can make the structure of data().get() and data().set() callback consistent with data().on() callback.

We can make the structure of data().on() callback as:
callback(const char* path, Var data)

and that of data().get() and data().set() callback as:
callback(const char* code, Var data)

Use would no longer have to use the [] notation of Var other than when representing JSON objects.

The loop function practically runs the SDK and makes the asynchronous behavior possible. User has to call it in the loop() of his/her Arduino sketch. It has nothing to do with a project, it's a function very specific to arduino architecture. Everywhere: on JS SDK and Py SDK, Project class provides access of and methods for interacting with the project space on Grandeur. loop isn't one of those.

My suggestion is, we keep Project, Device, Datastore classes pure and free of the architectural differences and move architecture-specific methods to Grandeur class. User would do grandeur.loop() instead.