README-EXAMPLE.md

ThinkingHome.Plugins.Mqtt

MqttPlugin

... назначение ...

Конфигурация

... вводный текст ...

{
    "plugins": {

        ...

        "ThinkingHome.Plugins.Mail.MqttPlugin": {
            ...
        }
    }
}

Данные

Ниже перечислены классы, определенные в пакете ThinkingHome.Plugins... для ... . Вы можете работать с ними с помощью плагина DatabasePlugin и Entity Framework Core.

ThinkingHome.Plugins....ClassName

Представляет собой ...

Таблица: Table_Name

Поля:

• Guid ... - описание.
• string ... - описание.

API

void Method(...)

... описание ...

Пример

Context.Require<MqttPlugin>()
    .Method(...);

[Event]

... описание события ...

Вы можете отметить методы своего плагина атрибутом EventAttribute. Метод вашего плагина будет автоматически вызываться при ... .

Сигнатура метода, вызываемого по таймеру, должна соответствовать делегату EventDelegate:

public delegate void EventDelegate(...);

Параметры:

• string ... - описание.
• byte[] ... - описание.

Пример:

[Event]
public void MyEventHandler(...)
{
    ...
}

HTTP API

/api/plugin/method

... описание ...

Параметры и возвращаемое значение

• name1 (type) - описание.
• name2 (type) - описание.

В ответ на клиент возвращается ...

{ ... }

Пример

curl 'http://localhost:8080/api/plugin/method?name1=value1&name2=value2'

API сценариев

methodName

... описание ...

Пример

host.api.methodName(...);

Сценарные события

event:name

Сценарное событие event:name генерируется ... . В обработчик события передаются параметры:

• arguments[0] - описание (string).
• arguments[1] - описание (Buffer).

Пример обработчика

var arg1 = arguments[0];
var arg2 = arguments[1];

host.log.info('...')