Public | Automated Build

Last pushed: 2 days ago
Short Description
MoBagel SDK for C
Full Description

MoBagel C++ SDK

Requirement

To install mobagel-cpp-sdk, you need the following tools/libraries in your environment :

  • cmake - Build mobagel-cpp-sdk library.
  • libcurl - perform HTTP/HTTPS.

Installation

$ git clone https://github.com/MOBAGEL/mobagel-c-sdk.git
$ cd mobagel-c-sdk
$ sudo ./install.sh

Getting Started

- Creating an account

If you do not have an account, please create an account here. After you create an account, you will be directed to the dashboard.

- Creating a new product

To use MoBagel, you first have to create a product, which is essentially a group of same device. You will be prompted to create a new product when you first enter the dashboard.

After you create a product, you can go to Configuration -> Device Info to retrieve your product_key, which will be used to create device later on.

- Adding custom properties

In the Configuration, you can add custom properties to your product. Custom properties should have the following requirements:

  • ID: Property ID (with the exception of state) should always begin with c_ to indicate that it is a custom property. In addition, property IDs are unique and cannot repeat with itself.

  • Name: The property name is your nickname for your property. For example, if your ID is 'c_012421', you can set the name as 'temperature'. The modules in the dashboard will display your property name instead of your property ID.

  • Type: There are two types of properties: category and numeric. Category uses a set of string options and numeric uses numeric options (optional).

  • Options:

    • Category: please add all the possible string values of your property by typing in the options column. The server will use this to prevent your devices from sending erroraneous reports.

    • Numeric (optional): please set a min and max value for your numeric property to help protect your data from errors. For example, if your numeric property is humidity level, then you can set min and max to 0 and 100, respectively. This will allow our system to reject any reports with humidity levels that are not in this range because those values are theoretically impossible (i.e. negative humidity level).

Please note that you must configure your properties in your configuration before you send your first customized report.

- Register your first device

Once you generated a product_key from the dashboard, you can use the product_key and registerDevice function to register a device in your application.

// register a device
string device_key = mobagel->registerDevice();

- Connecting custom properties or events

In your device application, you will need to prepare your report before sending it to MoBagel.

  • Determining different states of your devices to send along with your report
# Example states

"state": "normal"
"state": "error"
  • Adding custom properties or events with a key beginning with c_
# Example custom properties or events

"c_temperature": 30
"c_event": "turned_on"
  • Deciding when to send reports (time, frequency, events)

- Sending first report

Once you connect the sensor properties, you can generate a report with the sendReport function.

// send report from client
MoBagelReport report;
report.state("normal");
report.custom("temperature", 123);
report.custom("pressure", 123.12);
report.custom("label", "test");
client->sendReport(report, report_callback);

Test

Run the sample code just built for you.

$ ./build/examples/main

If you see the following response, congratulations!

Successfully register a device!Server timestamp: 1458016398
Successfully send a report: {"data":"56e790d2f8e9d32dc28b4567","timestamp":1458016399}

Example

// main.cpp

// Include header
#include <iostream>
#include <string>
#include <mobagel/mobagel.h>

using namespace std;

void time_callback(MoBagelResponse* res) {
    cout << "Time: ";
    res->print();
    cout << endl;
}

void report_callback(MoBagelResponse* res) {
    cout << "Report: ";
    res->print();
    cout << endl;
}

int main(int argc, const char * argv[]) {

    // create mobagel object
    string product_key = "1111111111222222222233333333334444444444555555555566666666667777";
    MoBagel *mobagel = new MoBagel(product_key);

    // register a device
    string device_key = mobagel->registerDevice();

    // create mobagel client
    // every device MUST need their own client
    MoBagelClient *client = new MoBagelClient(device_key);

    // get current timestamp
    client->getTime(time_callback);

    // send report from client
    MoBagelReport report;
    report.state("normal");
    report.custom("temperature", 123);
    report.custom("pressure", 123.12);
    report.custom("label", "test");
    client->sendReport(report, report_callback);

    return 0;
}

Run

$ g++ -o main examples/main.cpp -lmobagel -lcurl
$ ./main

More

You can visit our home page and get more information.
https://mobagel.com

Author

MoBagel, us@mobagel.com

License

MoBagel Software Development Kit (SDK) License Agreement

Subject to the terms of this License Agreement, you are hereby granted a worldwide, royalty-free, non-assignable, non-exclusive, and non-sublicensable license to use, copy, modify, and distribute this software in source code or binary form to use the SDK solely to develop applications to connect with MoBagel’s platform.

MoBagel owns all legal right, title and interest in and to the SDK. MoBagel reserves all rights not expressly granted to you.

The form and nature of the SDK that MoBagel provides may change without prior notice to you. This SDK is provided “as is”, without warranty of any kind, express or limited. MoBagel may stop (permanently or temporarily) providing the SDK to users at MoBagel's sole discretion without prior notice.

You are not granted the right to use MoBagel’s trademarks, logos, domain names, or other distinctive brand features.

Docker Pull Command
Owner
mobagel
Source Repository

Comments (0)