## lib/cmd * [lib/cmd](#module_lib/cmd) * [~Assign all connected devices and mock devices as private classes.](#module_lib/cmd..Assign all connected devices and mock devices as private classes.) * [new Assign all connected devices and mock devices as private classes.(cfg, proj, cam, light, alert, cam2, proj2, capper)](#new_module_lib/cmd..Assign all connected devices and mock devices as private classes._new) * [~Commands](#module_lib/cmd..Commands) * [.projector_forward()](#module_lib/cmd..Commands+projector_forward) ⇒ integer * [.projector_backward()](#module_lib/cmd..Commands+projector_backward) ⇒ integer * [.camera_forward(cmd)](#module_lib/cmd..Commands+camera_forward) ⇒ integer * [.black_forward()](#module_lib/cmd..Commands+black_forward) ⇒ integer * [.camera_backward(cmd)](#module_lib/cmd..Commands+camera_backward) ⇒ integer * [.black_backward()](#module_lib/cmd..Commands+black_backward) ⇒ integer * [.camera_second_forward(cmd)](#module_lib/cmd..Commands+camera_second_forward) ⇒ integer * [.camera_second_backward(cmd)](#module_lib/cmd..Commands+camera_second_backward) ⇒ integer * [.cameras_forward(cmd)](#module_lib/cmd..Commands+cameras_forward) ⇒ integer * [.cameras_backward(cmd)](#module_lib/cmd..Commands+cameras_backward) ⇒ integer * [.camera_forward_camera_second_backward(cmd)](#module_lib/cmd..Commands+camera_forward_camera_second_backward) ⇒ integer * [.camera_backward_camera_second_forward(cmd)](#module_lib/cmd..Commands+camera_backward_camera_second_forward) ⇒ integer * [.projector_second_forward()](#module_lib/cmd..Commands+projector_second_forward) ⇒ integer * [.projector_second_backward()](#module_lib/cmd..Commands+projector_second_backward) ⇒ integer * [.projectors_forward()](#module_lib/cmd..Commands+projectors_forward) ⇒ integer * [.projectors_backward()](#module_lib/cmd..Commands+projectors_backward) ⇒ integer * [.projector_forward_projector_second_backward()](#module_lib/cmd..Commands+projector_forward_projector_second_backward) ⇒ integer * [.projector_backward_projector_second_forward()](#module_lib/cmd..Commands+projector_backward_projector_second_forward) ⇒ integer * [.alert()](#module_lib/cmd..Commands+alert) ⇒ integer * [.pause()](#module_lib/cmd..Commands+pause) ⇒ integer * [.camera_exposure()](#module_lib/cmd..Commands+camera_exposure) ### lib/cmd~Assign all connected devices and mock devices as private classes. **Kind**: inner class of [lib/cmd](#module_lib/cmd) #### new Assign all connected devices and mock devices as private classes.(cfg, proj, cam, light, alert, cam2, proj2, capper) | Param | Type | Description | | --- | --- | --- | | cfg | object | Configuration object | | proj | object | Projector 1 | | cam | object | Camera 1 | | light | object | Light source | | alert | object | Alert object | | cam2 | object | (optional) Camera 2 | | proj2 | object | (optional) Projector 2 | | capper | object | Capper object | ### lib/cmd~Commands Class representing all commands bundled into methods. **Kind**: inner class of [lib/cmd](#module_lib/cmd) * [~Commands](#module_lib/cmd..Commands) * [.projector_forward()](#module_lib/cmd..Commands+projector_forward) ⇒ integer * [.projector_backward()](#module_lib/cmd..Commands+projector_backward) ⇒ integer * [.camera_forward(cmd)](#module_lib/cmd..Commands+camera_forward) ⇒ integer * [.black_forward()](#module_lib/cmd..Commands+black_forward) ⇒ integer * [.camera_backward(cmd)](#module_lib/cmd..Commands+camera_backward) ⇒ integer * [.black_backward()](#module_lib/cmd..Commands+black_backward) ⇒ integer * [.camera_second_forward(cmd)](#module_lib/cmd..Commands+camera_second_forward) ⇒ integer * [.camera_second_backward(cmd)](#module_lib/cmd..Commands+camera_second_backward) ⇒ integer * [.cameras_forward(cmd)](#module_lib/cmd..Commands+cameras_forward) ⇒ integer * [.cameras_backward(cmd)](#module_lib/cmd..Commands+cameras_backward) ⇒ integer * [.camera_forward_camera_second_backward(cmd)](#module_lib/cmd..Commands+camera_forward_camera_second_backward) ⇒ integer * [.camera_backward_camera_second_forward(cmd)](#module_lib/cmd..Commands+camera_backward_camera_second_forward) ⇒ integer * [.projector_second_forward()](#module_lib/cmd..Commands+projector_second_forward) ⇒ integer * [.projector_second_backward()](#module_lib/cmd..Commands+projector_second_backward) ⇒ integer * [.projectors_forward()](#module_lib/cmd..Commands+projectors_forward) ⇒ integer * [.projectors_backward()](#module_lib/cmd..Commands+projectors_backward) ⇒ integer * [.projector_forward_projector_second_backward()](#module_lib/cmd..Commands+projector_forward_projector_second_backward) ⇒ integer * [.projector_backward_projector_second_forward()](#module_lib/cmd..Commands+projector_backward_projector_second_forward) ⇒ integer * [.alert()](#module_lib/cmd..Commands+alert) ⇒ integer * [.pause()](#module_lib/cmd..Commands+pause) ⇒ integer * [.camera_exposure()](#module_lib/cmd..Commands+camera_exposure) #### commands.projector\_forward() ⇒ integer Move the projector one frame forward **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms #### commands.projector\_backward() ⇒ integer Move the projector one frame backward **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms #### commands.camera\_forward(cmd) ⇒ integer Move the camera one frame forward **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms | Param | Type | Description | | --- | --- | --- | | cmd | object | Full cmd object | #### commands.black\_forward() ⇒ integer Move the camera one frame forward with light off **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms #### commands.camera\_backward(cmd) ⇒ integer Move the camera one frame backward **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms | Param | Type | Description | | --- | --- | --- | | cmd | object | Full cmd object | #### commands.black\_backward() ⇒ integer Move the camera one frame forward, light set to black or off **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms #### commands.camera\_second\_forward(cmd) ⇒ integer Move the second camera one frame forward **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms | Param | Type | Description | | --- | --- | --- | | cmd | object | Full cmd object | #### commands.camera\_second\_backward(cmd) ⇒ integer Move the second camera one frame backward **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms | Param | Type | Description | | --- | --- | --- | | cmd | object | Full cmd object | #### commands.cameras\_forward(cmd) ⇒ integer Move the both cameras one frame forward **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms | Param | Type | Description | | --- | --- | --- | | cmd | object | Full cmd object | #### commands.cameras\_backward(cmd) ⇒ integer Move the both cameras one frame backward **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms | Param | Type | Description | | --- | --- | --- | | cmd | object | Full cmd object | #### commands.camera\_forward\_camera\_second\_backward(cmd) ⇒ integer Move first camera one frame forward and rewind secondary camera one frame backward **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms | Param | Type | Description | | --- | --- | --- | | cmd | object | Full cmd object | #### commands.camera\_backward\_camera\_second\_forward(cmd) ⇒ integer Rewind first camera one frame backward and move secondary camera one frame forward **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms | Param | Type | Description | | --- | --- | --- | | cmd | object | Full cmd object | #### commands.projector\_second\_forward() ⇒ integer Move the secondary projector forward one frame **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms #### commands.projector\_second\_backward() ⇒ integer Rewind the secondary projector backward one frame **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms #### commands.projectors\_forward() ⇒ integer Move the both projectors forward one frame **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms #### commands.projectors\_backward() ⇒ integer Rewind both projectors backwards one frame **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms #### commands.projector\_forward\_projector\_second\_backward() ⇒ integer Move the primary projector forward one frame and rewind the secondary projector one frame backwards. **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms #### commands.projector\_backward\_projector\_second\_forward() ⇒ integer Rewind the primary projector backwards one frame and move the secondary projector forward one frame. **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms #### commands.alert() ⇒ integer Throws an alert to pause a sequence **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms #### commands.pause() ⇒ integer Pauses a sequence for a length of time **Kind**: instance method of [Commands](#module_lib/cmd..Commands) **Returns**: integer - Length of action in ms #### commands.camera\_exposure() Sets the camera exposure (if supported). **Kind**: instance method of [Commands](#module_lib/cmd..Commands)