IGrblControllerService.java

/*
 *
 *   Goko
 *   Copyright (C) 2013, 2016  PsyKo
 *
 *   This program 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, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
package org.goko.controller.grbl.v09;

import org.goko.controller.grbl.v09.configuration.GrblConfiguration;
import org.goko.controller.grbl.v09.configuration.IGrblConfigurationListener;
import org.goko.core.common.exception.GkException;
import org.goko.core.controller.IControllerConfigurationFileExporter;
import org.goko.core.controller.IControllerConfigurationFileImporter;
import org.goko.core.controller.IControllerService;
import org.goko.core.controller.ICoordinateSystemAdapter;
import org.goko.core.controller.IJogService;
import org.goko.core.controller.IProbingService;
import org.goko.core.controller.IThreeAxisControllerAdapter;
import org.goko.core.gcode.element.GCodeLine;
import org.goko.core.gcode.element.ICoordinateSystem;
import org.goko.core.gcode.execution.ExecutionTokenState;
import org.goko.core.gcode.rs274ngcv3.context.GCodeContext;
import org.goko.core.gcode.rs274ngcv3.context.GCodeContextProvider;

/**
 * Definition of the Grbl service
 *
 * @author PsyKo
 *
 */
public interface IGrblControllerService extends IControllerService<ExecutionTokenState, GCodeContext>,
												IJogService,
												IThreeAxisControllerAdapter,
												ICoordinateSystemAdapter<ICoordinateSystem>,
												IControllerConfigurationFileExporter,
												IControllerConfigurationFileImporter,
												GCodeContextProvider,
												IProbingService{

	void setConfiguration(GrblConfiguration configuration) throws GkException;

	GrblConfiguration getConfiguration() throws GkException;

	GrblState getGrblState();

	void setActivePollingEnabled(boolean enabled) throws GkException;

	boolean isActivePollingEnabled() throws GkException;

	GrblMachineState getState() throws GkException;

	void setCheckModeEnabled(boolean enabled) throws GkException;

	int getUsedGrblBuffer() throws GkException;
	
	int getUsedGrblPlannerBuffer() throws GkException;

	void send(GCodeLine gCodeLine) throws GkException;
	
	void pauseMotion() throws GkException;;
	
	void stopMotion() throws GkException;
	
	void startMotion() throws GkException;
	
	void resumeMotion() throws GkException;
	
	/**
	 * Adds the given {@link IGrblConfigurationListener} as a listener to this service configuration event
	 * @param listener the listener to add
	 */
	void addConfigurationListener(IGrblConfigurationListener listener);
	
	/**
	 * Removes the given {@link IGrblConfigurationListener} from the listener of this service configuration event
	 * @param listener the listener to remove
	 */
	void removeConfigurationListener(IGrblConfigurationListener listener);
	
	/**
	 * Set this controller configuration. This method SHOULD send back the configuration to the Grbl board
	 * @param configuration the configuration to set
	 * @throws GkException GkException
	 */
	void updateConfiguration(GrblConfiguration configuration) throws GkException;
	
	/**
	 * Reset the Grbl board
	 * @throws GkException GkException
	 */
	void resetGrbl() throws GkException;
}