From bc077a24a1f63259cadf2138ba16208e9ae42b30 Mon Sep 17 00:00:00 2001 From: mmcwilliams Date: Tue, 19 Sep 2017 15:40:42 -0400 Subject: [PATCH] Document remaining functions in lib/intval --- lib/intval/Readme.md | 21 +++++++++++++++++++++ lib/intval/index.js | 12 ++++++++++++ 2 files changed, 33 insertions(+) diff --git a/lib/intval/Readme.md b/lib/intval/Readme.md index 3d4ed58..c58b565 100644 --- a/lib/intval/Readme.md +++ b/lib/intval/Readme.md @@ -13,7 +13,9 @@ Class representing the intval3 features * [._stop()](#Intval+_stop) * [._watchMicro(err, val)](#Intval+_watchMicro) * [._watchRelease(err, val)](#Intval+_watchRelease) + * [.setDir([dir])](#Intval+setDir) * [.frame([dir], [time], [delay])](#Intval+frame) + * [.sequence()](#Intval+sequence) @@ -87,6 +89,19 @@ Button + 10K ohm resistor | err | object | Error object present if problem reading pin | | val | integer | Current value of the pin | + + +### intval.setDir([dir]) +Set the default direction of the camera. +* forward = true +* backward = false + +**Kind**: instance method of [Intval](#Intval) + +| Param | Type | Default | Description | +| --- | --- | --- | --- | +| [dir] | boolean | true | Direction of the camera | + ### intval.frame([dir], [time], [delay]) @@ -100,3 +115,9 @@ Begin a single frame with set variables or defaults | [time] | integer | "null" | (optional) Exposure time, 0 = minimum | | [delay] | integer | "null" | (optional) Delay after frame before another can be started | + + +### intval.sequence() +Start a sequence of frames, using defaults or explicit instructions + +**Kind**: instance method of [Intval](#Intval) diff --git a/lib/intval/index.js b/lib/intval/index.js index b0b7c4f..35cb4ea 100644 --- a/lib/intval/index.js +++ b/lib/intval/index.js @@ -177,6 +177,14 @@ class Intval { } } } + /** + * Set the default direction of the camera. + * * forward = true + * * backward = false + * + * @param {boolean} [dir=true] Direction of the camera + * + */ setDir (val = true) { if (typeof val !== 'boolean') { return console.warn('Direction must be represented as either true or false') @@ -231,6 +239,10 @@ class Intval { } } } + /** + * Start a sequence of frames, using defaults or explicit instructions + * + */ sequence () { console.log(`Started sequence`) }