Procedure to add Yalgaar Recipe:

• Add below line in “/build/conf/local.conf” file to add the yalgaar recipe.
  • IMAGE_INSTALL_append += "yalgaar"
• Add yalgaarSDK(recipe package) to any custom meta-layer
  • copy “yalgaarSDK” Directory inside any custom meta layer.
  • Example of Full Path: /poky/meta-sls/meta-intel/recipes-*/yalgaarSDK
• Add YalgaarSDK contain meta-layer in bblayer.conf file
  • Example: BBLAYERS ?= " ##OEROOT##/poky/meta-sls/meta-intel "
• Create Board image using below command
  • bitbake [Board-specific Target]
  • Example:
    • bitbake core-minimal-image

Procedure to Test Example Binary on specific Board:

• Default path of “yalgaar_io.pem ” certificate file is “/usr/bin”.
• Test the Generated example binary on Board using below command
  • cd /usr/bin
  • ./yalgaarSDK

Include "yalgaar_api.h" in your code.

#include "yalgaar_api.h"

To connect to a Yalgaar client, use following method, it must have valid Client Key.

yalgaar_connect(char *clientKey,bool isSecure,char *uuid,char *AES_SECURITY_KEY,unsigned int AESTYPE,void(*connectionCallback) (yalgaar_error_t error_msg));

Parameter:

• clientKey
  • Description: Yalgaar provided authentic client key for project.
  • DataType: unsigned char
• isSecure
  • Description: Specified connection is establish with SSL or not.
  • DataType: boolean (value must be true or false)
• uuid
  • Description: Any unique user name for user to enable presence feature for client. UUID is CASE SENSITIVE and only alpha numeric, hyphens,@,underscore allowed and maximum length must be 50.
  • DataType: unsinged char
• AES_SECURITY_KEY
  • Description: Secret key use for encrypt/decrypt message.
  • DataType: unsigned char
• AESTYPE
  • Description: Type of AES algorithm use for encrypt/decrypt message. Support AES type 128,192 and 256.
  • DataType: unsigned int
• connectionCallback
  • Description: Called when successfully connected to server or any error during connection.
  • DataType: ENUM (yalgaar_error_t)

To publish message, use following method.

yalgaar_publish(const unsigned char *channel,char *message);

Parameter:

• channel
  • Description: Channel name to be publish message. Only alpha numeric, hyphens, @, underscore allowed and maximum length must be 50.
  • DataType: unsigned char
• message
  • Description: Data to be send on given channel.
  • DataType: unsigned char

To subscribe message, use following method.

yalgaar_subscribe(char *channel,void(*subscribeMessageCallback)(void *),void(*presenceMessageCallback)(struct presence_t *),void(*errorMessageCallback)(void *));
yalgaar_subscribes(char **channel,void(*subscribeMessageCallback)(void *),void(*presenceMessageCallback)(struct presence_t *),void(*errorMessageCallback)(void *));

Parameter:

• channel
  • Description: channel name on which message will be subscribed. For multiple channel names use "yalgaar_subscribes" function. Channel name is CASE SENSITIVE. Only alpha numeric, hyphens, @, underscore allowed and maximum length must be 50.
  • DataType: unsigned char
• subscribeMessageCallback
  • Description: Callback function to consume received message.
  • DataType: void *
• presenceMessageCallback
  • Description: Callback function to consume presence events such as join or leave.
  • DataType: struct presence_t *
• errorMessageCallback
  • Description: Callback is called on system error occurred during subscription.
  • DataType: void *

To unsubscribe message, use following method.

yalgaar_unsubscribe(channel);

• channel
  • Description: Channel name to be unsubscribe. Channel name is CASE SENSITIVE. Only alpha numeric, hyphens, @, underscore allowed and maximum length must be 50.
  • DataType: unsigned char

To get list of all user subscribe with specified channel name, use following method.

yalgaar_GetUserList(char *channel,void(*userListCallback)(Sll *),void(*errorMessageCallback)(void *));

Parameter:

• channel
  • Description: Valid channel name. Channel name is CASE SENSITIVE and only alpha numeric, hyphens, @, underscore allowed and maximum length must be 50.
  • DataType: unsigned char
• userListCallback
  • Description: Callback is called when successfully get user list.
  • DataType: Sll *
• errorMessageCallback
  • Description: Callback is called on system error occurred during getting user list.
  • DataType: void *

To get list of all channels subscribed by specified user, use following method.

yalgaar_GetChannelList(char *UUID,void(*channelListCallback)(Sll *),void(*errorMessageCallbacks)(void *));

Parameter:

• UUID
  • Description: Any unique user name or user id. UUID is CASE SENSITIVE and only alpha numeric, hyphens,@,underscore allowed and maximum length must be 50.
  • DataType: unsigned char
• channelListCallback
  • Description: Callback is called when successfully get channel list.
  • DataType: Sll *
• errorMessageCallbacks
  • Description: Callback is called on system error occurred during getting channel list.
  • DataType: void *

To get message history from specified channel name, use following method.

yalgaar_GetHistoryMessage(char *channelName,char *messageCount,void(* historymessagecallback)(char *),void(*errorMessageCallback)(char *));

Parameter:

• channelName
  • Description: Valid channel name. Channel name is CASE SENSITIVE and only alpha numeric, hyphens, @, underscore allowed and maximum length must be 50.
  • DataType: unsigned char
• messageCount
  • Description: How many messages that you want to fetch. Maximum 100 messages allow at a time.
  • DataType: char *
• historymessagecallback
  • Description: Callback is called when successfully get history message list.
  • DataType: char *
• errorMessageCallbacks
  • Description: Callback is called on system error occurred during getting history message.
  • DataType: void *

To disconnect connection with YalgaarClient, use following method.

yalgaar_disconnect();