intval3/lib/intval/Readme.md

Intval

Class representing the intval3 features

Kind: global class

• Intval
  • ._declarePins()
  • ._undeclarePins()
  • ._startFwd()
  • ._startBwd()
  • ._stop()
  • ._watchMicro(err, val)
  • ._watchRelease(err, val)
  • .setDir([dir])
  • .frame([dir], [time])
  • .sequence()

intval._declarePins()

(internal function) Declares all Gpio pins that will be used

Kind: instance method of Intval

intval._undeclarePins()

(internal function) Undeclares all Gpio in event of uncaught error that interupts the node process

Kind: instance method of Intval

intval._startFwd()

Start motor in forward direction by setting correct pins in h-bridge

Kind: instance method of Intval

intval._startBwd()

Start motor in backward direction by setting correct pins in h-bridge

Kind: instance method of Intval

intval._stop()

Stop motor by setting both motor pins to 0 (LOW)

Kind: instance method of Intval

intval._watchMicro(err, val)

Callback for watching relese switch state changes. Using GPIO 06 on Raspberry Pi Zero W.

1. If closed AND frame active, start timer, set state primed to true.
2. If opened AND frame active, stop frame

Microswitch + 10K ohm resistor

• 1 === open
• 0 === closed

Kind: instance method of Intval

Param	Type	Description
err	object	Error object present if problem reading pin
val	integer	Current value of the pin

intval._watchRelease(err, val)

Callback for watching relese switch state changes. Using GPIO 05 on Raspberry Pi Zero W.

1. If closed, start timer.
2. If opened, check timer AND
3. If press (NOW - this._state.release.time) greater than minimum and less than this._releaseSequence, start frame
4. If press greater than this._releaseSequence, start sequence

Button + 10K ohm resistor

• 1 === open
• 0 === closed

Kind: instance method of Intval

Param	Type	Description
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

Param	Type	Default	Description
[dir]	boolean	true	Direction of the camera

intval.frame([dir], [time])

Begin a single frame with set variables or defaults

Kind: instance method of Intval

Param	Type	Default	Description
[dir]	boolean	"null"	(optional) Direction of the frame
[time]	integer	"null"	(optional) Exposure time, 0 = minimum

intval.sequence()

Start a sequence of frames, using defaults or explicit instructions

Kind: instance method of Intval