intval3/lib/intval/Readme.md

3.1 KiB

Intval

Class representing the intval3 features

Kind: global class

intval._declarePins()

Intval._declarePins() - (internal function) Declares all Gpio pins that will be used

Kind: instance method of Intval

intval._undeclarePins()

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

Kind: instance method of Intval

intval._startFwd()

Intval._startFwd() - Start motor in forward direction by setting correct pins in h-bridge

Kind: instance method of Intval

intval._startBwd()

Intval._startBwd() - Start motor in backward direction by setting correct pins in h-bridge

Kind: instance method of Intval

intval._stop()

Intval._stop() - Stop motor by setting both motor pins to 0 (LOW)

Kind: instance method of Intval

intval._watchMicro(err, val)

Intval._watchMicro() - Callback for watching microswitch state changes Using GPIO 06 on raspberry pi zero w

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)

Intval._watchRelease() - Callback for watching relese switch state changes Using GPIO 05 on raspberry pi zero w

  • If closed, start timer.
  • If opened, check timer AND
  • If time closed longer than minimum and less than this._releaseSequence, start frame
  • If time closed longer than this._releaseSequence, start sequence

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.frame(dir, time, delay)

Intval.frame() - Begin a single frame with set variables or defaults

Kind: instance method of Intval

Param Type Default Description
dir boolean (optional) Direction of the frame
time integer (optional) Exposure time, 0 = minimum
delay delay (optional) Delay after frame before another can be started