Stepdance Software Library
Loading...
Searching...
No Matches
Eibotboard Class Reference

Enables using Axidraw commands from over serial as motion stream input. More...

#include <interfaces.hpp>

Inheritance diagram for Eibotboard:

Public Member Functions

void begin ()
 Initialize the EiBotBoard interface. This must be called to set up the interface. Default communication interface is Serial.
void begin (usb_serial_class *target_usb_serial)
 Initialize the EiBotBoard interface with a specified communication interface.
void set_ratio_xy (float output_units_mm, float input_units_steps)
 Set the conversion ratio between XY steps and millimeters.
void set_ratio_z (float output_units_mm, float input_units_steps)
 Set the conversion ratio between Z steps and millimeters.

Public Attributes

BlockPortoutput_x = target_interpolator.output_x
 BlockPort for X axis output. Use this to map to downstream components to drive position based on the EiBotBoard x-axis position data.
BlockPortoutput_y = target_interpolator.output_y
 BlockPort for Y axis output. Use this to map to downstream components to drive position based on the EiBotBoard y-axis position data.
BlockPortoutput_z = target_interpolator.output_z
 BlockPort for Z axis output. Use this to map to downstream components to drive position based on the EiBotBoard z-axis position data.

Protected Member Functions

void loop ()

Detailed Description

Enables using Axidraw commands from over serial as motion stream input.

The Eibotboard class emulates the Axidraw EiBotBoard interface, allowing standard AxiDraw workflows to provide direct input. It processes serial commands sent over the axidraw inteface (e.g. from Inkscape or from the AxiDraw Python library), to generate motion streams corresponding to the geometry of input SVG drawings. To use with Inkscape, select the "AxiDraw Control" extension and set the output port to the serial port connected to the StepDance controller running this interface.

For an example of how to use this class, see axidraw_interface/axidraw_interface.ino

Member Function Documentation

◆ begin()

void Eibotboard::begin ( usb_serial_class * target_usb_serial)

Initialize the EiBotBoard interface with a specified communication interface.

Parameters
target_usb_serialA pointer to a communication interface, e.g. &Serial or &SerialUSB1.

◆ set_ratio_xy()

void Eibotboard::set_ratio_xy ( float output_units_mm,
float input_units_steps )

Set the conversion ratio between XY steps and millimeters.

Parameters
output_units_mmThe output units in millimeters.
input_units_stepsThe input units in steps.

◆ set_ratio_z()

void Eibotboard::set_ratio_z ( float output_units_mm,
float input_units_steps )

Set the conversion ratio between Z steps and millimeters.

Parameters
output_units_mmThe output units in millimeters.
input_units_stepsThe input units in steps.

The documentation for this class was generated from the following file: