SMACONT | Обмен данными. ioControl

Содержание

Общие данные
Действие «ioControl_Send()», «ioControl_SendText()»
Действие «ioControl_Read()»

Общие данные

Бесплатный и простой облачный сервис «ioControl» предназначен для управления интернетом вещей и не только.

Основной идеей сервиса «ioControl» (iocontrol.ru) являются данные, концептуально оформленные как три типа переменных (int, float, string), и визуально оформленные как настраиваемые карточки в панели пользователя, к которым возможен доступ через сеть Интернет при помощи API сервиса, приложения на смартфоне или браузера. Это позволяет обмениваться ими между микроконтроллерами (и не только), находящимися в разных частях планеты.

Подробнее про реализацию API, типы переменных и их внешний вид можно узнать по этой ссылке.

Сервис «ioControl»

Сервис имеет удобное приложение для устройств, под управлением операционной системы «Android». Приложение обладает всеми возможностями, доступными на сайте.

Сервис «ioControl». Приложение

Следует выделить следующие достоинства сервиса «ioControl»:
- возможность построения графиков;
- возможность управления устройствами непосредственно из сервиса «ioControl».

Отправка данных производится по HTTP/HTTPS протоколу методом GET. Метод используется для отправки данных в сервис, для последующего сохранения в нем.

Предусмотрено два способа отправки данных: без использования ключа доступа и с использованием ключа доступа. Применение отправки данных с ключом доступа, повышает безопасность работы с сервисом «ioControl».

GET-запрос без ключа доступа

http://iocontrol.ru/api/sendData/{board}/{variable}/{value}

GET-запрос с ключом доступа

http://iocontrol.ru/api/sendData/{board}/{variable}/{value}?key=agfdsdsgsdfdfsgsfd

Значение полей

{board} - Название панели, длина от 5 до 20 символов, допускается использовать только латиницу, цифры и символ "_" (подчеркивание).
{variable} - Имя переменной из указанной панели, длина от 1 до 20 символов, допускается использовать только латиницу, цифры и символ "_" (подчеркивание).
{value} - Значение переменной, которое необходимо передать для в сервис для сохранения.
{key} - Ключ доступа, в случае когда панель в режиме доступа по ключу. Приватный режим работы.

Пример GET-запроса

http://iocontrol.ru/api/sendData/SmaCont/Temperature/123.12345?key=agfdsdsgsdfdfsgsfd

Характеристики сервиса

• API позволяет осуществлять один запрос в секунду с одного IP адреса.
• Историю изменения переменных можно узнать до 30 дней назад.
• Панели хранятся в течение 30 дней с даты последнего изменения любой переменной в панели. Если в течение 30 дней ни одна переменная в панели не была изменена, панель удаляется и её имя освобождается.
• Так же как и история переменных, архив хранит историю переменных до 30 дней назад и, так же как и срок хранения панелей, архив хранится в течение 30 дней с даты последнего изменения любой из переменных в панели.

Ограничения переменных

• int - Переменная целочисленного типа: переменная ограничена 64-битным числом со знаком.
• float - Переменная вещественного типа с плавающей точкой: мантисса может содержать от 1 до 5 знаков (меняется в настройках) после точки.
• string - текстовая переменная: переменная ограничена 16-ю символами и может содержать только строчные и заглавные символы латинского алфавита, цифры и знак подчёркивания '_'.

Действие «ioControl_Send()», «ioControl_SendText()»

Для передачи данных на сервис «ioControl», используется действие «ioControl_Send()».

В качестве параметров, действие использует заранее заполненные шаблоны.

Smacont. Действие «ioControl_SendText()»

Действие «ioControl_Send()», «ioControl_SendText()»

Ключ доступа («key»)

Ключ доступа, в случае когда панель в режиме доступа по ключу. Приватный режим работы. Никому не сообщайте значение параметра «key».

В случае работы с сервисом без ключа доступа, параметр необходимо установить в значение «-».

Название панели («board»)

Название панели

Имя переменной («variable»). Действие «ioControl_Send()»

Имя переменной

Значение переменной («value»). Действие «ioControl_Send()»

Значение переменной «Vx», которое необходимо передать в сервис для сохранения.

Текстовое сообщение («text»). Действие «ioControl_Send()»

Текстовая переменная «text», которое необходимо передать в сервис для сохранения.

Длина от 1 до 16 символов, можно использовать только латиницу, цифры и символ: «_» подчеркивания. Символ «_» подчеркивания при отображении н сервисе выглядит как пробел. Все остальные символы игнорируется.

Состояние обмена

Параметр «Состояние обмена» предназначен для контроля состояния обмена между устройством и сервисом. Для этого необходимо «привязать» параметр, к любой переменной «Vx». Значения параметра «Состояние обмена» перечислены здесь.

Действие «ioControl_Read()»

Действие «ioControl_Read()» используется для чтения данных из сервиса.

В качестве параметров, действие использует заранее заполненные шаблоны.

Действие рекомендуется периодически выполнять при помощи сценариев, например, по событию одного из таймера. При этом, период выполнения действия, должен быть не менее одной секунды (ограничение сервиса).