# Stop

This function block stops a running scenario when it receives a TRUE boolean signal. It is intended for use in continuous UI mode where a manual or programmatic stop request must gracefully halt the scenario.

## 📥 Inputs <a href="#inputs" id="inputs"></a>

`Boolean` A boolean signal that, when TRUE, requests the scenario to stop (only effective in continuous UI mode).

## 📤 Outputs <a href="#outputs" id="outputs"></a>

This function block does not provide outputs.

## 🕹️ Controls <a href="#controls" id="controls"></a>

This block has no interactive controls. It acts solely on the incoming boolean signal.

## 🎨 Features <a href="#features" id="features"></a>

* Graceful stop request for scenarios running in continuous UI mode.
* Minimal and dedicated: designed only to accept a boolean trigger for stopping.
* Safe to place in output sections where a final stop condition is required.

## 📝 Usage Instructions <a href="#usage" id="usage"></a>

1. Place the block in the outputs area of your scenario.
2. Provide a boolean source to the input that will become TRUE when you want the scenario to stop.
3. Run the scenario in continuous UI mode — when the input becomes TRUE the stop will be triggered.

## 📊 Evaluation <a href="#evaluation" id="evaluation"></a>

When the input boolean becomes TRUE while the scenario runs in continuous UI mode, the block issues a stop request. If the environment is not running in continuous UI mode, the stop request will have no effect.

## 💡 Tips and Tricks <a href="#tips-and-tricks" id="tips-and-tricks"></a>

* Use `Logic Input` for a manual on-screen stop button you can toggle during runs.
* Use `Keyboard/Barcode Reader` to stop the scenario with a key press or barcode scan.
* Use `Rising Edge` to convert a sustained TRUE signal into a single stop event (prevents repeated stop requests).
* Use `Debug Input` to inspect and verify the boolean signal being sent to this block when troubleshooting.
* Combine with `Set - Reset` patterns to control when the stop condition is allowed to activate.

## 🛠️ Troubleshooting <a href="#troubleshooting" id="troubleshooting"></a>

* Nothing happens when triggered: Confirm the scenario is running in continuous UI mode — the stop is ignored in other run modes.
* Stop triggers repeatedly: Use a rising-edge or set/reset arrangement to ensure a single stop event.
* Signal not reaching block: Verify the boolean source is connected and producing a proper boolean value; use `Debug Input` to check the signal.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.augelab.com/function-blocks/input-output/outputs-exports/stop.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.