gsender

/*
 * Copyright (C) 2021 Sienci Labs Inc.
 *
 * This file is part of gSender.
 *
 * gSender is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, under version 3 of the License.
 *
 * gSender is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with gSender.  If not, see <https://www.gnu.org/licenses/>.
 *
 * Contact for information regarding this program and its license
 * can be sent through gSender@sienci.com or mailed to the main office
 * of Sienci Labs Inc. in Waterloo, Ontario, Canada.
 *
 */

/* eslint max-len: 0 */
import {
	ALARMS,
	HOMING_ALARM,
	MODAL_GROUPS,
	SETTINGS_INPUT_TYPES,
} from "../shared/constants";

// Grbl
export const GRBL = "Grbl";

// Active State
export {
	ACTIVE_STATE_IDLE as GRBL_ACTIVE_STATE_IDLE,
	ACTIVE_STATE_RUN as GRBL_ACTIVE_STATE_RUN,
	ACTIVE_STATE_HOLD as GRBL_ACTIVE_STATE_HOLD,
	ACTIVE_STATE_DOOR as GRBL_ACTIVE_STATE_DOOR,
	ACTIVE_STATE_HOME as GRBL_ACTIVE_STATE_HOME,
	ACTIVE_STATE_SLEEP as GRBL_ACTIVE_STATE_SLEEP,
	ACTIVE_STATE_ALARM as GRBL_ACTIVE_STATE_ALARM,
	ACTIVE_STATE_CHECK as GRBL_ACTIVE_STATE_CHECK,
} from "../shared/constants";

// Real-time Commands: ~, !, ?, and Ctrl-x
export const GRBL_REALTIME_COMMANDS = [
	"~", // Cycle Start
	"!", // Feed Hold
	"?", // Current Status
	"\x18", // Reset Grbl (Ctrl-X)
];

// https://github.com/grbl/grbl/wiki/Configuring-Grbl-v0.9
// http://linuxcnc.org/docs/html/gcode/overview.html#cap:modal-groups
export const GRBL_MODAL_GROUPS = Object.values(MODAL_GROUPS);

// Errors
// https://github.com/gnea/grbl/blob/master/doc/csv/error_codes_en_US.csv
export const GRBL_ERRORS = [
	{
		code: 1,
		message: "Expected command letter",
		description:
			"G-code words consist of a letter and a value. Letter was not found.",
	},
	{
		code: 2,
		message: "Bad number format",
		description:
			"Missing the expected G-code word value or numeric value format is not valid.",
	},
	{
		code: 3,
		message: "Invalid statement",
		description: "Grbl $' system command was not recognized or supported.",
	},
	{
		code: 4,
		message: "Value < 0",
		description: "Negative value received for an expected positive value.",
	},
	{
		code: 5,
		message: "Setting disabled",
		description: "Homing cycle failure. Homing is not enabled via settings.",
	},
	{
		code: 6,
		message: "Value < 3 usec",
		description: "Minimum step pulse time must be greater than 3usec.",
	},
	{
		code: 7,
		message: "EEPROM read fail. Using defaults",
		description:
			"An EEPROM read failed. Auto-restoring affected EEPROM to default values.",
	},
	{
		code: 8,
		message: "Not idle",
		description:
			"Grbl '$' command cannot be used unless Grbl is IDLE. Ensures smooth operation during a job.",
	},
	{
		code: 9,
		message: "G-code lock",
		description: "G-code commands are locked out during alarm or jog state.",
	},
	{
		code: 10,
		message: "Homing not enabled",
		description: "Soft limits cannot be enabled without homing also enabled.",
	},
	{
		code: 11,
		message: "Line overflow",
		description:
			"Max characters per line exceeded. Received command line was not executed.",
	},
	{
		code: 12,
		message: "Step rate > 30kHz",
		description:
			"Grbl '$' setting value cause the step rate to exceed the maximum supported.",
	},
	{
		code: 13,
		message: "Check Door",
		description: "Safety door detected as opened and door state initiated.",
	},
	{
		code: 14,
		message: "Line length exceeded",
		description:
			"Build info or startup line exceeded EEPROM line length limit. Line not stored.",
	},
	{
		code: 15,
		message: "Travel exceeded",
		description:
			"Jog target exceeds machine travel. Jog command has been ignored.",
	},
	{
		code: 16,
		message: "Invalid jog command",
		description: "Jog command has no '=' or contains prohibited g-code.",
	},
	{
		code: 17,
		message: "Setting disabled",
		description: "Laser mode requires PWM output.",
	},
	{
		code: 20,
		message: "Unsupported command",
		description: "Unsupported or invalid g-code command found in block.",
	},
	{
		code: 21,
		message: "Modal group violation",
		description:
			"More than one g-code command from same modal group found in block.",
	},
	{
		code: 22,
		message: "Undefined feed rate",
		description: "Feed rate has not yet been set or is undefined.",
	},
	{
		code: 23,
		message: "Invalid g-code ID:23",
		description: "G-code command in block requires an integer value.",
	},
	{
		code: 24,
		message: "Invalid g-code ID:24",
		description:
			"More than one g-code command that requires axis words found in block.",
	},
	{
		code: 25,
		message: "Invalid g-code ID:25",
		description: "Repeated g-code word found in block.",
	},
	{
		code: 26,
		message: "Invalid g-code ID:26",
		description:
			"No axis words found in block for g-code command or current modal state which requires them.",
	},
	{
		code: 27,
		message: "Invalid g-code ID:27",
		description: "Line number value is invalid.",
	},
	{
		code: 28,
		message: "Invalid g-code ID:28",
		description: "G-code command is missing a required value word.",
	},
	{
		code: 29,
		message: "Invalid g-code ID:29",
		description: "G59.x work coordinate systems are not supported.",
	},
	{
		code: 30,
		message: "Invalid g-code ID:30",
		description: "G53 only allowed with G0 and G1 motion modes.",
	},
	{
		code: 31,
		message: "Invalid g-code ID:31",
		description:
			"Axis words found in block when no command or current modal state uses them.",
	},
	{
		code: 32,
		message: "Invalid g-code ID:32",
		description: "G2 and G3 arcs require at least one in-plane axis word.",
	},
	{
		code: 33,
		message: "Invalid g-code ID:33",
		description: "Motion command target is invalid.",
	},
	{
		code: 34,
		message: "Invalid g-code ID:34",
		description: "Arc radius value is invalid.",
	},
	{
		code: 35,
		message: "Invalid g-code ID:35",
		description: "G2 and G3 arcs require at least one in-plane offset word.",
	},
	{
		code: 36,
		message: "Invalid g-code ID:36",
		description: "Unused value words found in block.",
	},
	{
		code: 37,
		message: "Invalid g-code ID:37",
		description:
			"G43.1 dynamic tool length offset is not assigned to configured tool length axis.",
	},
	{
		code: 38,
		message: "Invalid g-code ID:38",
		description: "Tool number greater than max supported value.",
	},
];

// Alarms
// https://github.com/gnea/grbl/blob/master/doc/csv/alarm_codes_en_US.csv
export const GRBL_ALARMS = [...ALARMS, HOMING_ALARM];

export const GRBL_SETTINGS_INPUT_TYPES = SETTINGS_INPUT_TYPES;

const { NUMBER, AXIS_MASK, MASK_STATUS_REPORT, SWITCH } =
	GRBL_SETTINGS_INPUT_TYPES;

// Settings
// https://github.com/gnea/grbl/blob/master/doc/csv/setting_codes_en_US.csv
export const GRBL_SETTINGS = [
	{
		setting: "$0",
		message: "Step pulse time",
		category: "Motors",
		units: "μs",
		description: "Sets time length per step. Minimum 3usec.",
		inputType: NUMBER,
		min: 0,
		max: 20,
		step: 1,
	},
	{
		setting: "$1",
		message: "Step idle delay",
		category: "Motors",
		units: "ms",
		description:
			"Sets a short hold delay when stopping to let dynamics settle before disabling steppers. Value 255 keeps motors enabled with no delay.",
		inputType: NUMBER,
		min: 25,
		max: 255,
		step: 5,
	},
	{
		setting: "$2",
		message: "Step pulse invert",
		category: "Motors",
		units: "mask",
		description: "Inverts the step signal. Set axis bit to invert (00000ZYX).",
		inputType: AXIS_MASK,
	},
	{
		setting: "$3",
		message: "Step direction invert",
		category: "Motors",
		units: "mask",
		description:
			"Inverts the direction signal. Set axis bit to invert (00000ZYX).",
		inputType: AXIS_MASK,
	},
	{
		setting: "$4",
		message: "Invert step enable pin",
		category: "Pins",
		units: "boolean",
		description: "Inverts the stepper driver enable pin signal.",
		inputType: SWITCH,
	},
	{
		setting: "$5",
		message: "Invert limit pins",
		category: "Pins",
		units: "boolean",
		description: "Inverts the all of the limit input pins.",
		inputType: SWITCH,
	},
	{
		setting: "$6",
		message: "Invert probe pin",
		category: "Pins",
		units: "boolean",
		description: "Inverts the probe input pin signal.",
		inputType: SWITCH,
	},
	{
		setting: "$10",
		message: "Status report options",
		category: "GRBL",
		units: "mask",
		description: "Alters data included in status reports.",
		inputType: MASK_STATUS_REPORT,
	},
	{
		setting: "$11",
		message: "Junction deviation",
		category: "GRBL",
		units: "mm",
		description:
			"Sets how fast Grbl travels through consecutive motions. Lower value slows it down.",
		inputType: NUMBER,
		min: 0.001,
		step: 0.001,
	},
	{
		setting: "$12",
		message: "Arc tolerance",
		category: "GRBL",
		units: "mm",
		description:
			"Sets the G2 and G3 arc tracing accuracy based on radial error. Beware: A very small value may effect performance.",
		inputType: NUMBER,
		min: 0.001,
		step: 0.001,
	},
	{
		setting: "$13",
		message: "Report in inches",
		category: "GRBL",
		units: "boolean",
		description:
			"Enables inch units when returning any position and rate value that is not a settings value.",
		inputType: SWITCH,
	},
	{
		setting: "$20",
		message: "Soft limits enable",
		category: "Homing",
		units: "boolean",
		description:
			"Enables soft limits checks within machine travel and sets alarm when exceeded. Requires homing.",
		inputType: SWITCH,
	},
	{
		setting: "$21",
		message: "Hard limits enable",
		category: "Homing",
		units: "boolean",
		description:
			"Enables hard limits. Immediately halts motion and throws an alarm when switch is triggered.",
		inputType: SWITCH,
	},
	{
		setting: "$22",
		message: "Homing cycle enable",
		category: "Homing",
		units: "boolean",
		description: "Enables homing cycle. Requires limit switches on all axes.",
		inputType: SWITCH,
	},
	{
		setting: "$23",
		message: "Homing direction invert",
		category: "Homing",
		units: "mask",
		description:
			"Homing searches for a switch in the positive direction. Set axis bit (00000ZYX) to search in negative direction.",
		inputType: AXIS_MASK,
	},
	{
		setting: "$24",
		message: "Homing locate feed rate",
		category: "Homing",
		units: "mm/min",
		description:
			"Feed rate to slowly engage limit switch to determine its location accurately.",
		inputType: NUMBER,
		min: 1,
		step: 1,
	},
	{
		setting: "$25",
		message: "Homing search seek rate",
		category: "Homing",
		units: "mm/min",
		description:
			"Seek rate to quickly find the limit switch before the slower locating phase.",
		inputType: NUMBER,
		min: 100,
		step: 100,
	},
	{
		setting: "$26",
		message: "Homing switch debounce delay",
		category: "Homing",
		units: "ms",
		description:
			"Sets a short delay between phases of homing cycle to let a switch debounce.",
		inputType: NUMBER,
		min: 5,
		max: 255,
		step: 5,
	},
	{
		setting: "$27",
		message: "Homing switch pull-off distance",
		category: "Homing",
		units: "mm",
		description:
			"Retract distance after triggering switch to disengage it. Homing will fail if switch isn't cleared.",
		inputType: NUMBER,
		min: 0,
		step: 0.5,
	},
	{
		setting: "$30",
		message: "Maximum spindle speed",
		category: "Spindle",
		units: "rpm",
		description: "Maximum spindle speed. Sets PWM to 100% duty cycle.",
		inputType: NUMBER,
		min: 100,
		step: 100,
	},
	{
		setting: "$31",
		message: "Minimum spindle speed",
		category: "Spindle",
		units: "rpm",
		description:
			"Minimum spindle speed. Sets PWM to 0.4% or lowest duty cycle.",
		inputType: NUMBER,
		min: 1,
		step: 1,
	},
	{
		setting: "$32",
		message: "Laser-mode enabled as spindle",
		category: "Spindle",
		units: "boolean",
		description:
			"Converts spindle commands into laser mode. Consecutive G1/2/3 commands will not halt when spindle speed is changed.",
		inputType: SWITCH,
	},
	{
		setting: "$100",
		message: "X-axis travel resolution",
		category: "Motors",
		units: "step/mm",
		description: "X-axis travel resolution in steps per millimeter.",
		inputType: NUMBER,
		min: 10,
		step: 10,
	},
	{
		setting: "$101",
		message: "Y-axis travel resolution",
		category: "Motors",
		units: "step/mm",
		description: "Y-axis travel resolution in steps per millimeter.",
		inputType: NUMBER,
		min: 10,
		step: 10,
	},
	{
		setting: "$102",
		message: "Z-axis travel resolution",
		category: "Motors",
		units: "step/mm",
		description: "Z-axis travel resolution in steps per millimeter.",
		inputType: NUMBER,
		min: 10,
		step: 10,
	},
	{
		setting: "$110",
		message: "X-axis maximum rate",
		category: "Motors",
		units: "mm/min",
		description: "X-axis maximum rate. Used as G0 rapid rate.",
		inputType: NUMBER,
		min: 100,
		step: 100,
	},
	{
		setting: "$111",
		message: "Y-axis maximum rate",
		category: "Motors",
		units: "mm/min",
		description: "Y-axis maximum rate. Used as G0 rapid rate.",
		inputType: NUMBER,
		min: 100,
		step: 100,
	},
	{
		setting: "$112",
		message: "Z-axis maximum rate",
		category: "Motors",
		units: "mm/min",
		description: "Z-axis maximum rate. Used as G0 rapid rate.",
		inputType: NUMBER,
		min: 10,
		step: 10,
	},
	{
		setting: "$120",
		message: "X-axis acceleration",
		category: "Motors",
		units: "mm/sec^2",
		description:
			"X-axis acceleration. Used for motion planning to not exceed motor torque and lose steps.",
		inputType: NUMBER,
		min: 1,
		step: 10,
	},
	{
		setting: "$121",
		message: "Y-axis acceleration",
		category: "Motors",
		units: "mm/sec^2",
		description:
			"Y-axis acceleration. Used for motion planning to not exceed motor torque and lose steps.",
		inputType: NUMBER,
		min: 1,
		step: 10,
	},
	{
		setting: "$122",
		message: "Z-axis acceleration",
		category: "Motors",
		units: "mm/sec^2",
		description:
			"Z-axis acceleration. Used for motion planning to not exceed motor torque and lose steps.",
		inputType: NUMBER,
		min: 1,
		step: 10,
	},
	{
		setting: "$130",
		message: "X-axis maximum travel",
		category: "Limits",
		units: "mm",
		description:
			"Maximum X-axis travel distance from homing switch. Determines valid machine space for soft-limits and homing search distances.",
		inputType: NUMBER,
		min: 1,
		step: 10,
	},
	{
		setting: "$131",
		message: "Y-axis maximum travel",
		category: "Limits",
		units: "mm",
		description:
			"Maximum Y-axis travel distance from homing switch. Determines valid machine space for soft-limits and homing search distances.",
		inputType: NUMBER,
		min: 1,
		step: 10,
	},
	{
		setting: "$132",
		message: "Z-axis maximum travel",
		category: "Limits",
		units: "mm",
		description:
			"Maximum Z-axis travel distance from homing switch. Determines valid machine space for soft-limits and homing search distances.",
		inputType: NUMBER,
		min: 1,
		step: 10,
	},
];