====== @amperka/relay ======

Библиотека для управления [[amp>product/troyka-relay|модулем реле]], [[amp>product/arduino-relay-shield|Relay Shield]]’ом и другими реле.

<code javascript>
var myRelay = require('@amperka/relay').connect(P2);

// замыкаем реле
myRelay.turnOn();

// размыкаем реле
myRelay.turnOff();

// замыкаем реле на 3 секунды
myRelay.blink(3);

// каждые 2 секунды замыкаем реле на 1 секунду
myRelay.blink(1, 2);
</code>

===== Функции модуля =====

func:: connect(pin)

Возвращает новый объект ''Relay'' для управления реле, подключённому к пину ''pin''.

<code javascript>
var myRelay = require('@amperka/relay').connect(P2);
</code>



class:: Relay

Класс для работы с реле. Для создания нового объекта, используйте функцию ''connect''.

meth:: Relay.turnOn()

Замыкает реле. Если на реле был запущен таймер методом ''Relay.blink'' — он будет сброшен.

meth:: Relay.turnOff()

Размыкает реле. Если на реле был запущен таймер методом ''Relay.blink'' — он будет сброшен.

meth:: Relay.toggle([on])

Изменяет состояние реле на противоположное. Если задан параметр ''on'', типа ''boolean'', включает или отключает реле. Функция не сбрасывает таймер реле ''Relay.blink'', если он задействован.

meth:: Relay.blink(delay, [period])

Включает реле по таймеру, на ''delay'' секунд, после чего отключает его. Если задан параметр ''period'', реле будет включаться на ''delay'' секунд один раз в ''period'' секунд. Параметр ''delay'' должен быть больше ''0.2'' для того, чтобы реле успело сработать. Параметр ''period'' должен быть больше ''delay + 0.2''. Для сброса таймера, необходимо воспользоваться методами ''Relay.turnOn()'' или ''Relay.turnOff()''.