p5.axidraw 1.0.0 | Documentation

p5.axidraw

1.0.0

STEPS_PER_MM
MAX_MM_PER_SEC
MIN_MM_PER_SEC
AxiDraw ▸
- Instance members
- #isBusy
- #connect
- #disconnect
- #enable
- #disable
- #currentPosition
- #penUp
- #penDown
- #setPenHeight
- #setSpeed
- #moveTo
- #analogConfigure
- #analogRead
- #memoryRead

Need help reading this?

STEPS_PER_MM

The number of motor steps per millimeter. See https://shop.evilmadscientist.com/productsmenu/846.

STEPS_PER_MM

Type: number

MAX_MM_PER_SEC

The maximum speed of the AxiDraw in millimeters per second. See https://shop.evilmadscientist.com/productsmenu/846.

MAX_MM_PER_SEC

Type: number

MIN_MM_PER_SEC

The minimum speed of the AxiDraw in millimeters per second. See https://evil-mad.github.io/EggBot/ebb.html#SM.

MIN_MM_PER_SEC

Type: number

AxiDraw

A class for controlling the AxiDraw pen plotter.

new AxiDraw()

Instance Members

▸ isBusy()

True if the AxiDraw is executing commands.

isBusy(): boolean

Returns

boolean:

▸ connect()

Connect to the AxiDraw via USB serial. This will pop up a browser dialog asking the user to select the USB serial connection for the AxiDraw.

connect(): Promise<void>

Returns

Promise<void>: Resolves when the connection is established.

▸ disconnect()

Disconnect from the AxiDraw.

disconnect(): Promise<void>

Returns

Promise<void>: Resolves when the connection is closed.

▸ enable()

Enable the motors in the AxiDraw. This will "lock" the position of the pen, so it can't be moved by hand. Movement commands automatically enable the motors, so this is usually not needed. The command is queued, so it will be executed after any previous commands.

enable(): Promise<void>

Returns

Promise<void>: Resolves when the motors are enabled.

▸ disable()

Disable the motors in the AxiDraw. This will "unlock" the position of the pen, so it can be moved by hand. The command is queued, so it will be executed after any previous commands.

disable(): Promise<void>

Returns

Promise<void>: Resolves when the motors are disabled.

▸ currentPosition()

Get the current XY position of the pen in millimeters. Asks the AxiDraw for the current position, and converts the motor steps to millimeters. The command is queued, so it will be executed after any previous commands.

currentPosition(): Promise<{x: number, y: number}>

Returns

Promise<{x: number, y: number}>: Resolves with the current position.

▸ penUp()

Raise the pen. The command is queued, so it will be executed after any previous commands.

penUp(): Promise<void>

Returns

Promise<void>: Resolves when the pen is raised.

▸ penDown()

Lower the pen. The command is queued, so it will be executed after any previous commands.

penDown(): Promise<void>

Returns

Promise<void>: Resolves when the pen is lowered.

▸ setPenHeight(normalizedHeight)

Directly control the pen lift servo position.

setPenHeight(normalizedHeight: number): Promise<void>

Parameters

normalizedHeight (number) The servo position in the range [0, 1]. 1 is up and 0 is down.

Returns

Promise<void>: Resolves when the command is sent.

▸ setSpeed(mmPerSec)

Set the speed of the pen.

setSpeed(mmPerSec: number)

Parameters

mmPerSec (number) The speed in millimeters per second.

▸ moveTo(x, y)

Move the pen to a position specified by an XY coordinate in millimeters. The command is queued, so it will be executed after any previous commands.

moveTo(x: number, y: number): Promise<void>

Parameters

x (number) The X coordinate in millimeters.

y (number) The Y coordinate in millimeters.

Returns

Promise<void>: Resolves when the pen has reached the destination.

▸ analogConfigure(channel, enabled)

Configure an analog input channel.

Channel	Pin	Comments
0	RA0	Connected to current adjustment trim-pot
1	RA1
2	RA2
3	RA3	(don't use) Pen lift servo power enable
4	RA5
5	RE0	(don't use) Motor enable 1
6	RE1	(don't use) MS2
7	RE2	(don't use) MS1
8	RB2	Servo connector JP3
9	RB3	Servo connector JP4
10	RB1	Pen lift servo connector
11	RC2
12	RB0	Servo connector JP2

analogConfigure(channel: number, enabled: boolean): Promise<void>

Parameters

channel (number) The analog channel number (0-12).

enabled (boolean) Whether the channel should be enabled.

Returns

Promise<void>: Resolves when the channel is configured.

analogRead

▸ analogRead(channel)

Read an analog input channel. The value is normalized to a range of 0-1, where 1 represents 3.3V. The channel must be enabled with analogConfigure first. See analogConfigure for a list of channels and their pins.

analogRead(channel: number): Promise<number>

Parameters

channel (number) The analog channel number (0-12).

Returns

Promise<number>: Resolves with the normalized value (0-1).

analogConfigure

▸ memoryRead(address)

Read a byte from RAM at the specified address. See https://evil-mad.github.io/EggBot/ebb.html#MR.

memoryRead(address: number): Promise<number>

Parameters

address (number) Address to read (0 to 4095).

Returns

Promise<number>: Resolves with the value at the given address (0-255).