1.0.0Read all analog input values. See https://evil-mad.github.io/EggBot/ebb.html#A.
Promise<any>:
Resolves with an object whose keys are the analog.
channel numbers and whose values are the analog values (0-1023).
Configure an analog input channel. See https://evil-mad.github.io/EggBot/ebb.html#AC.
(number)
The analog channel number (0-15).
(boolean)
Whether the channel should be enabled.
Promise<void>:
Resolves after the command has been acknowledged.
Enter bootloader mode. See https://evil-mad.github.io/EggBot/ebb.html#BL.
Promise<void>:
Resolves after the EBB has been disconnected.
Configure all pins as inputs or outputs at once. See https://evil-mad.github.io/EggBot/ebb.html#C and the PIC18F46J50 datasheet. A pin is an input if the corresponding bit in the TRIS register is 1.
Zero the motor step positions. See https://evil-mad.github.io/EggBot/ebb.html#CS.
Promise<void>:
Resolves after the command has been acknowledged.
Configure user interface options. See https://evil-mad.github.io/EggBot/ebb.html#CU.
Enable or disable stepper motors and set step mode. See https://evil-mad.github.io/EggBot/ebb.html#EM.
Promise<void>:
Resolves after the command has been acknowledged.
Aborts any in-progress motor move and deletes any motor move commands from the FIFO. See https://evil-mad.github.io/EggBot/ebb.html#ES.
(boolean?)
Whether to de-energize the motors.
Promise<EStopInfo>:
Resolves after the command has been acknowledged.
Move to an absolute position relative to home. Only meant for "utility" moves rather than smooth/fast motion. Read the current global position using QS (@see queryStepPosition) and clear it using CS (@see clearStepPosition). If no destination position is specified, then the move is towards the Home position (0, 0). See https://evil-mad.github.io/EggBot/ebb.html#HM.
Read every byte-wide PORTx register (A-E) and return the values. See https://evil-mad.github.io/EggBot/ebb.html#I.
Promise<Array<number>>:
Resolves with an array of the port values.
Low-level, step-limited move command. Causes one or both motors to move for a given number of steps, and allows the option of applying a constant acceleration to one or both motors during their movement. The motion terminates for each axis when the required number of steps have been made, and the command is complete when the both motors have reached their targets. See https://evil-mad.github.io/EggBot/ebb.html#LM.
(number)
Step rate for motor 1 (0 to 2^31-1). Added to the
motor 1 accumulator at each control interval (40us).
(number)
Number of steps for motor 1 (-2^31 to 2^31-1).
(number)
Added to the step rate at each control interval (40us).
(boolean)
Zeroes the motor 1 accumulator before starting if true.
(number)
Step rate for motor 2 (0 to 2^31-1). Added to the
motor 2 accumulator at each control interval (40us).
(number)
Number of steps for motor 2 (-2^31 to 2^31-1).
(number)
Added to the step rate at each control interval (40us).
(boolean)
Zeroes the motor 2 accumulator before starting if true.
Promise<void>:
Resolves after the command has been acknowledged.
Low-level, time-limited move command. causes one or both motors to move for a given duration of time, and allows the option of applying a constant acceleration to one or both motors during their movement. The motion terminates for each axis when the required number of time intervals has elapsed. See https://evil-mad.github.io/EggBot/ebb.html#LT.
(number)
Number of 40us time intervals for the motors to move (0 to 2^31-1).
(number)
Step rate for motor 1 (-(2^31-1) to 2^31-1).
Absolute value is added to the motor 1 accumulator at each control interval
(40us). Sign determines direction.
(number)
Added to the step rate at each control interval (40us). -2^31 to
2^31-1.
(boolean)
Zeroes the motor 1 accumulator before starting if true.
(number)
Step rate for motor 2 (-(2^31-1) to 2^31-1).
Absolute value is added to the motor 2 accumulator at each control interval
(40us). Sign determines direction.
(number)
Added to the step rate at each control interval (40us). -2^31 to
2^31-1.
(boolean)
Zeroes the motor 2 accumulator before starting if true.
Promise<void>:
Resolves after the command has been acknowledged.
Read the byte value at a memory address. See https://evil-mad.github.io/EggBot/ebb.html#MR.
(number)
Address to read (0 to 4095).
Promise<number>:
Resolves with the byte value at the given address.
Write a byte value at the given memory address. See https://evil-mad.github.io/EggBot/ebb.html#MW.
Promise<void>:
Resolves after the command has been acknowledged.
Decrement the node counter by 1. See https://evil-mad.github.io/EggBot/ebb.html#ND.
Promise<void>:
Resolves after the command has been acknowledged.
Increment the node counter by 1. See https://evil-mad.github.io/EggBot/ebb.html#NI.
Promise<void>:
Resolves after the command has been acknowledged.
Output digital values to the pins of the microcontroller. The pins must have been configured as digital outputs. See https://evil-mad.github.io/EggBot/ebb.html#O.
(number)
Value to write to port A (0 to 255).
(number)
Value to write to port B (0 to 255).
(number)
Value to write to port C (0 to 255).
(number)
Value to write to port D (0 to 255).
(number)
Value to write to port E (0 to 255).
Promise<void>:
Resolves after the command has been acknowledged.
Configures the pulse generator parameters. See https://evil-mad.github.io/EggBot/ebb.html#PC.
(number)
Duration in milliseconds that pulse 0 will be high (0 to 65535).
(number)
Period for pulse 0 in milliseconds (0 to 65535).
(number)
Duration in milliseconds that pulse 1 will be high (0 to 65535).
(number)
Period for pulse 1 in milliseconds (0 to 65535).
(number)
Duration in milliseconds that pulse 2 will be high (0 to 65535).
(number)
Period for pulse 2 in milliseconds (0 to 65535).
(number)
Duration in milliseconds that pulse 3 will be high (0 to 65535).
(number)
Period for pulse 3 in milliseconds (0 to 65535).
Promise<void>:
Resolves after the command has been acknowledged.
Set the direction of a pin. See https://evil-mad.github.io/EggBot/ebb.html#PD.
(string)
Letter of the processor port the pin belongs to. A, B, C, D, or E.
(number)
Index of the pin to use. 0 to 7.
(boolean)
Set pin to output if true, input if false.
Promise<void>:
Resolves after the command has been acknowledged.
Start or stop pulse generation. See https://evil-mad.github.io/EggBot/ebb.html#PG.
(boolean)
Start pulse generation if true, stop if false.
Promise<void>:
Resolves after the command has been acknowledged.
Read the state of a pin. See https://evil-mad.github.io/EggBot/ebb.html#PI.
(string)
Letter of the processor port the pin belongs to. A, B, C, D, or E.
(number)
Index of the pin to use. 0 to 7.
Promise<boolean>:
Resolves with true if the pin is high, false if low.
Write a digital value to a pin.
(string)
Letter of the processor port the pin belongs to. A, B, C, D, or E.
(number)
Index of the pin to use. 0 to 7.
(boolean)
Set pin high if true, low if false.
Promise<void>:
Query whether the button was pressed since the last time this command was called. See https://evil-mad.github.io/EggBot/ebb.html#QB.
Promise<boolean>:
Resolves with true if the button was pressed, false if not.
Read the max current setting and the power voltage. See https://evil-mad.github.io/EggBot/ebb.html#QC.
(boolean
= false)
Set to true if using an EBB board v2.2 or older.
Promise<{maxCurrent: number, powerVoltage: number}>:
Resolves
with the max current setting and the power voltage.
Query the current motor configuration. Firmware versions v2.8.0 and newer. See https://evil-mad.github.io/EggBot/ebb.html#QE.
Promise<Array<number>>:
Resolves with an array of step modes for each motor.
Query the general status. See https://evil-mad.github.io/EggBot/ebb.html#QG.
Promise<GeneralStatus>:
Resolves with the general status.
Query the current value of the layer variable. See https://evil-mad.github.io/EggBot/ebb.html#QL.
Promise<number>:
Resolves with the value of the current layer variable.
Query the status of the motors and motion FIFO. See https://evil-mad.github.io/EggBot/ebb.html#QM.
MotorStatus:
Query the pen status. See https://evil-mad.github.io/EggBot/ebb.html#QP.
Promise<boolean>:
Whether the pen is down (true) or down (true).
Query the servo power status. See https://evil-mad.github.io/EggBot/ebb.html#QR.
Promise<boolean>:
True if the servo is receiving power.
Query the step position of the motors. See https://evil-mad.github.io/EggBot/ebb.html#QS.
Promise<Array<number>>:
The step position of the motors.
Query the EBB's nickname. See https://evil-mad.github.io/EggBot/ebb.html#QT.
Promise<string>:
The nickname.
Reboot the EBB. See https://evil-mad.github.io/EggBot/ebb.html#RB.
Promise<void>:
Resolves when the EBB has been disconnected.
Reset the EBB.
Promise<void>:
Resolves when the EBB has been reset.
Control the RC servo output system. See https://evil-mad.github.io/EggBot/ebb.html#S2.
(number)
The "on time" of the signal, in units of 1/12e6 seconds.
(number)
The pin index to use.
(number)
Slew rate between last setting and the new one. 1/12e3 second per 24 ms.
(number)
Delay the next command in the motion queue by this many milliseconds.
Promise<void>:
Resolves when the command has been acknowledged.
Configure stepper and servo modes. See https://evil-mad.github.io/EggBot/ebb.html#SC.
Promise<void>:
Resolves when the command has been acknowledged.
Enable or disable and configure the engraver. See https://evil-mad.github.io/EggBot/ebb.html#SE.
(boolean)
Whether to enable the engraver.
(number)
The power to use (0-1023).
(boolean)
Whether to use the motion queue.
Promise<void>:
Resolves when the command has been acknowledged.
Set the value of the layer variable.
(number)
The value to set.
Promise<void>:
Resolves when the command has been acknowledged.
Move the stepper motors.
(number)
The duration of the move in milliseconds (1 to 2^24-1).
(number)
The number of steps to move motor 1 (-(2^24-1) to 2^24-1).
(number)
The number of steps to move motor 2 (-(2^24-1) to 2^24-1).
Promise<void>:
Resolves when the command has been acknowledged.
Set the node count. See https://evil-mad.github.io/EggBot/ebb.html#SN.
(number)
The node count (0-2^32).
Promise<void>:
Resolves when the node count has been set.
Set the pen state. See https://evil-mad.github.io/EggBot/ebb.html#SP.
(boolean)
Whether the pen should be down (true) or up (false).
(number?)
Duration in milliseconds
(number?)
Port B pin number (0-7)
Promise<void>:
Resolves when the command has been acknowledged.
Set the servo power timeout. See https://evil-mad.github.io/EggBot/ebb.html#SR.
(number)
Duration in milliseconds (0-2^32).
(boolean)
Whether to set the power on (true) or off (false).
Promise<void>:
Set this EBB's nickname. See https://evil-mad.github.io/EggBot/ebb.html#ST.
(string)
Promise<void>:
Resolves when the nickname has been set.
Turn on or off timed readings. See https://evil-mad.github.io/EggBot/ebb.html#T.
(number)
Duration in milliseconds (1-2^16).
(boolean)
Whether to use digital mode (true) or analog mode (false).
Promise<void>:
Resolves when the command has been acknowledged.
Toggle the state of the pen up or down. See https://evil-mad.github.io/EggBot/ebb.html#TP.
(number?)
Duration in milliseconds
Promise<void>:
Resolves when the pen state has been toggled.
Query the node count. See https://evil-mad.github.io/EggBot/ebb.html#QN.
Promise<number>:
Resolves to the node count.
Query the EBB version. See https://evil-mad.github.io/EggBot/ebb.html#V.
Promise<string>:
Resolves to the EBB version string.
Stepper move, for mixed-axis geometries. See https://evil-mad.github.io/EggBot/ebb.html#XM.
Promise<void>:
Resolves when the command is acknowledged.
Type: Object
Type: Object
(boolean)
: True if pin RB5 is high.
(boolean)
: True if pin RB2 is high.
(boolean)
: True if the PRG button was pressed since last QG or QB command.
(boolean)
: True if the pen is down.
(boolean)
: True if a command is executing.
(boolean)
: True if motor 1 is moving.
(boolean)
: True if motor 2 is moving.
(boolean)
: True if the FIFO is empty.
Type: Object