Skip to content

Commands

[beacon]

BEACON_QUERY

BEACON_QUERY: Output the next sample from beacon.

BEACON_STREAM

BEACON_STREAM FILENAME=<name> Streams full bandwidth beacon data to the given filename. Data is stored in CSV format.

BEACON_CALIBRATE

BEACON_CALIBRATE [SKIP_MANUAL_PROBE=<skip>] [NOZZLE_Z=<z>] [FLOOR=<floor>] [CEIL=<ceil>] [SPEED=<cal_speed>] [MOVE_SPEED=<move_speed>]: Start the beacon calibration routine. The manual Z offset script will be activated to position the nozzle against the bed using the paper test. After ACCEPTing the Z offset, the beacon response will be measured over the sensing range, and the beacon model constructed. SKIP_MANUAL_PROBE will skip the manual process, and assumes the nozzle is already positioned against the bed.

BEACON_ESTIMATE_BACKLASH

BEACON_ESTIMATE_BACKLASH [OVERRUN=<overrun>] [PROBE_SPEED=<mm/s>] [LIFT_SPEED=<mm/s>] [Z=<z_position>] [SAMPLES=<count>]: Estimate Z backlash using a series of ranging measurements from opposing approach directions. OVERRUN is the backoff distance between measurements.

BED_MESH_CALIBRATE

BED_MESH_CALIBRATE [METHOD=<method>] [SPEED=<mm/s>] [PROBE_SPEED=<mm/s>] [RUNS=<runs>] [CLUSTER_SIZE=<mm>] [RELATIVE_REFERENCE_INDEX=<index>] [PROBE_METHOD=<contact|proximity>] [USE_CONTACT_AREA=<0|1>] [ADAPTIVE=<0|1>]: Perform a bed mesh calibration. METHOD=beacon is the default and will run a scan mode mesh. METHOD=automatic will run a stop and sample or dive mode mesh, depending if the horizontal_move_z in the config is within ranging distance or not.

PROBE

PROBE [PROBE_SPEED=<mm/s>] [LIFT_SPEED=<mm/s>] [PROBE_METHOD=<contact|proximity>]: Perform a Z probe operation. If beacon is within ranging distance, a ranging measurement is used. Otherwise a dive is made to the trigger point, and then a ranging measurement is used.

PROBE_ACCURACY

PROBE_ACCURACY [PROBE_SPEED=<mm/s>] [SAMPLES=<count>] [LIFT_SPEED=<mms/>] [SAMPLE_RETRACT_DIST=<mm>]: Performs multiple probe operations and calculates statistics on the samples.

Z_OFFSET_APPLY_PROBE

Z_OFFSET_APPLY_PROBE: Applies the present Z offset to the active beacon model.

[beacon_model]

BEACON_MODEL_SELECT

BEACON_MODEL_SELECT NAME=<name>: Activate beacon model with the given name.

BEACON_MODEL_SAVE

BEACON_MODEL_SAVE NAME=<name>: Save active beacon model to the config file as name. Requires a SAVE_CONFIG to apply changes.

BEACON_MODEL_REMOVE

BEACON_MODEL_REMOVE NAME=<name>: Remove beacon model with name from the config file. Requires a SAVE_CONFIG to apply changes.

BEACON_MODEL_LIST

BEACON_MODEL_LIST: List available beacon models.

[beacon_contact]

BEACON_AUTO_CALIBRATE

BEACON_AUTO_CALIBRATE [SPEED=<speed>] [ACCEL=<accel>] [RETRACT=<retract_dist>] [RETRACT_SPEED=<retract_speed>] [SAMPLES=<sample_count>] [SAMPLES_TOLERANCE=<samples_tolerance>] [SAMPLES_TOLERANCE_RETRIES=<samples_tolerance_retries>] [SKIP_MODEL_CREATION=<1>]:

Uses Contact to find zero and perform a BEACON_CALIBRATE routine automatically. Calibration will be performed at the machine's present X, Y coordinate. SKIP_MODEL_CREATION can be used to skip the scan mode model calibration step, and do only the z offset.

BEACON_POKE

BEACON_POKE [SPEED=<speed>] [BOTTOM=<z_bottom>] [TOP=<z_top>]:

Performs a contact operation with added safeguards for assessing performance and running experiments.

BEACON_OFFSET_COMPARE

BEACON_OFFSET_COMPARE [TOP=<z_top>]:

Performs a comparison of contact and proximity measurements at the present position for investigating mismatches between the two modes.

G28

G28 [<axes>] [METHOD=<contact|proximity>] [CALIBRATE=<0|1>]:

If using the safe_z_home functionality, new options are added to G28 to choose homing method -- contact or proximity -- and when to recalibrate the beacon model used for proximity.

BED_MESH_CALIBRATE

BED_MESH_CALIBRATE [PROBE_METHOD=<contact|proximity>] [USE_CONTACT_AREA=<0|1>]:

PROBE_METHOD provides a means for switching between contact and proximity (scan) meshes. USE_CONTACT_AREA can be used to shrink the size of the scan mode mesh to match the points probed by contact for 1:1 comparisons.

Z_TILT_ADJUST QUAD_GANTRY_LEVEL SCREWS_TILT_ADJUST DELTA_CALIBRATE PROBE

<COMMAND> [PROBE_METHOD=<contact|proximity>]:

PROBE_METHOD is added to the above commands for switching between contact and proximity modes.