====== @amperka/sharp-ir-meter ======
<WRAP center round important 60%>
Библиотека пока в разработке
</WRAP>

Библиотека для чтения расстояния с [[amp>collection/proximity-sensors|инфракрасных дальномеров Sharp]].

Несмотря на то, что дальномеры от Sharp легко подключаются и выдают значение расстояния в виде аналогового сигнала, их правильная интерпретация — не самая тривиальная задача.

Библиотека помогает получить с сенсора значение расстояния в понятных единицах.

<code javascript>
var mySensor = require('@amperka/sharp-ir-meter').connect(A0, 'GP2Y0A02YK');

// Альтернативный способ подключения с указанием диапазона вместо модели
//var mySensor = require('@amperka/sharp-ir-meter').connect(A0, '20-150');

// Альтернативный способ с использованием объектов
//var Irm = require('@amperka/sharp-ir-meter');
//var mySensor = Irm.connect(A0, Irm.Models.GP2Y0A02YK);

// Выводим значение в миллиметрах
console.log(mySensor.read('mm'));
</code>

===== Функции и объекты модуля =====

func:: connect(pin, params)

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

В ''params'' задаются коэффициенты для преобразования аналогового сигнала в расстояние, которые зависят от модели дальномера. Используйте объект ''Models'', чтобы задать параметры своего дальномера.

Вместо объекта в ''params'' можно передать строку: название модели дальномера или соответствующий ей диапазон расстояний. См. пример выше.
class:: Models

Объект-коллекция моделей дальномеров.

prop:: GP2Y0A41

Одноимённый дальномер с диапазоном 4–30 см.

prop:: GP2Y0A021

Одноимённый дальномер с диапазоном 10–80 см.

prop:: GP2Y0A02YK

Одноимённый дальномер с диапазоном 20–150 см.

class:: SharpIrMeter

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

meth:: SharpIrMeter.read([units])

Возвращает значение с датчика в единицах, заданных параметром ''units''. В качестве единиц принимаются:
  * ''"mV"'' — значение как есть, в милливольтах;
  * ''"V"'' — значение как есть, в вольтах;
  * не задан — значение как есть в условных единицах из диапазона [0.0, 1.0];
  * ''"mm"'' — значение в миллиметрах;
  * ''"сm"'' — значение в сантиметрах;
  * ''"m"'' — значение в метрах;