> For the complete documentation index, see [llms.txt](https://documentation.hak5.org/wifi-pineapple-pager/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.hak5.org/wifi-pineapple-pager/ringtone.md).

# RINGTONE

`RINGTONE` Play a ringtone or ringtone file. A ringtone is \[a RTTTL format]\(/wifi-pineapple-pager/device/ringtones/) monophonic series of notes.

### When to use it <a href="#when-to-use-it" id="when-to-use-it"></a>

Use `RINGTONE` to play a custom (or pre-installed system) ringtone, with optional vibration. Ringtones volume will still be controlled by the users volume preferences.

#### Syntax <a href="#syntax" id="syntax"></a>

```none
RINGTONE {vibrate} [rtttl or filename]
```

**vibrate**

Vibrate in sync with the ringtone. Each note will be treated as a short-duration vibration for the vibration motor.

**rtttl or filename&#x20;*****required***

Play the supplied RTTTL ringtone, or play a RTTTL file.

To play a custom ringtone, use the entire RTTTL ringtone here.

To play a ringtone file, pass the name of the file here. `RINGTONE` looks for ringtone files in `/root/ringtones/`.

### Results <a href="#results" id="results"></a>

`RINGTONE` will exit with an error if another ringtone (or vibration pattern) is currently playing.

### Examples <a href="#examples" id="examples"></a>

```bash
# Play the default `alert.rtttl` ringtone, with vibration
RINGTONE --vibrate "alert"
```

```bash
# Play a custom ringtone
RINGTONE "custom:d=16,o=4,b=200:8e4,8g4,8a#4,8d5,8b6"
```

{% hint style="info" %}
Remember to enclose the prompt text in quotes if it contains spaces!<br>
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://documentation.hak5.org/wifi-pineapple-pager/ringtone.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
