Skip to content

Latest commit

 

History

History
119 lines (80 loc) · 2.83 KB

README.md

File metadata and controls

119 lines (80 loc) · 2.83 KB
Raw

libsupla

SUPLA is an open source project for home automation.

libsupla library

This library can be used to create devices and services connected with SUPLA Cloud. If compared with more complex supla-device which is like firmware/SDK based on Arduino lib ported to various platforms this library concept is more classical, and has less dependencies.

Supported platforms

This library has been tested on following platforms:

Getting started

To compile this library on Linux please install first:

sudo apt-get install libssl-dev

or use NOSSL=1 flag to compile without SSL support

Then run

make all

and to install library:

sudo make install

From now you can start to write your own software connected with SUPLA Just add to your C code:

#include <libsupla/device.h>

and add linker flag -lsupla and -lssl if compiled without NOSSL=1 flag

The basics

Device

We will start from creation of SUPLA device object:

supla_dev_t *dev = supla_dev_create("Test Device",NULL);

Then we need SUPLA Cloud connection config like:

static struct supla_config supla_config = {
	.email = "user@example.com",
	.auth_key = {0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00},
	.guid = {0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00},
	.server = "svr.supla.org",
	.ssl = 1
};

You must have supla account registered with email address and to quick start - generate your device data using links below:

SUPLA device must be configured before first connection:

supla_dev_set_config(dev,&supla_config);

Channels

SUPLA device uses channels. We can start from the most basic thermometer channel:

static supla_channel_t *temp_channel;

static supla_channel_config_t temp_channel_config = {
	.type = SUPLA_CHANNELTYPE_THERMOMETER ,
	.supported_functions = SUPLA_CHANNELFNC_THERMOMETER,
	.default_function = SUPLA_CHANNELFNC_THERMOMETER,
};

To create and add channel to device use following functions:

temp_channel = supla_channel_create(&temp_channel_config);
supla_dev_add_channel(dev,temp_channel);

In seperate thread/task we can set temperature

supla_channel_set_double_value(temp_channel,temp);

And in main SUPLA thread put supla_dev_iterate inside infinite loop

while(!app_quit){
	supla_dev_iterate(dev);
	usleep(10000);
}

Device would automatically synchronize channels data with server