https://github.com/qb4-dev/libsupla
Free library to create devices connected with SUPLA - Open Source building automation system
https://github.com/qb4-dev/libsupla
esp8266 homeautomation iot linux supla
Last synced: 6 months ago
JSON representation
Free library to create devices connected with SUPLA - Open Source building automation system
- Host: GitHub
- URL: https://github.com/qb4-dev/libsupla
- Owner: QB4-dev
- License: gpl-2.0
- Created: 2022-09-27T18:37:12.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-03-16T19:21:16.000Z (7 months ago)
- Last Synced: 2025-04-13T13:55:17.188Z (6 months ago)
- Topics: esp8266, homeautomation, iot, linux, supla
- Language: C
- Homepage:
- Size: 717 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# libsupla
[SUPLA](https://www.supla.org) 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](https://github.com/SUPLA/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:
- Linux
- ESP8266 as [RTOS-SDK Component](https://github.com/QB4-dev/esp-libsupla) (currently without SSL/TLS)
- ESP32 as [ESP-IDF Component](https://github.com/QB4-dev/esp-libsupla) (currently without SSL/TLS)
## 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](https://www.supla.org)
Just add to your C code:
```
#include
```
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:
- [AUTHKEY generator](https://www.supla.org/arduino/get-authkey)
- [GUID generator](https://www.supla.org/arduino/get-guid)
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