> For the complete documentation index, see [llms.txt](https://docs.remote.it/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.remote.it/software/bluetooth-wifi-onboarding-package-r3onboard.md).

# Bluetooth Wifi Onboarding Package (r3onboard)

Bluetooth WiFi Onboarding is a solution developed by Remote.It to simplify the process of setting up new devices. Our product leverages Bluetooth Low Energy (BLE) technology to allow users to easily connect and configure WiFi settings. Additionally, it provides the capability to register devices with the Remote.It service.

Bluetooth WiFi Onboarding makes setting up and managing your devices simple and efficient. Experience the convenience of remote access and simplified network configuration with Remote.It.

### [r3Onboard GitHub Repo](https://link.remote.it/github/ble)

### [remote.it App for using r3onboard](https://link.remote.it/getting-started/rpi-ble-image)

### Key Features

* **Easy WiFi Configuration:** Connect via Bluetooth LE to configure WiFi settings and get your device on the network effortlessly.
* **Remote Access:** Register your device with the Remote.It service.
* **Compatibility:** Designed to work with Bookworm Debian packages, with a primary focus on Raspberry Pi devices.

### Option 1: Use our pre built pi image

If you are using a raspberry pi you can use our prebuilt image with r3Onboard already installed. [Click here for details on using the prebuilt pi image.](<https://link.remote.it/getting-started/rpi-ble-image >)

### Option 2: Create your own image with r3onboard already installed

#### Manually Installing the [r3onboard Debian Package](https://downloads.remote.it/r3onboard/latest/r3onboard_all.deb)

To install the `r3onboard` package, follow these steps:

1. **Download the Package to `/tmp`:**

   ```sh
   wget -P /tmp https://downloads.remote.it/r3onboard/latest/r3onboard_all.deb
   ```
2. **Install the Package with apt:**

   ```sh
   sudo apt update
   sudo apt install /tmp/r3onboard_all.deb
   ```
3. **Service Management:**
   * The `r3onboard` service will start automatically on boot.
   * You can manually start the service with:

     ```sh
     sudo systemctl start r3onboard
     ```
4. **Create an Image:**
   * Once the package is installed, you can create a system image for deployment.
   * Use your preferred imaging tool to create a backup of your system after installing `r3onboard`.

#### Automate Installing the r3onboard Debian Package

You can use tools like `systemd-nspawn` to mount and boot an existing system image on your own machine. You can then install the Debian package once booted with systemd-nspawn. The `updateImage.sh` script in the repo can be used for ideas and is how we create the raspberry pi image.

### Viewing Logs

Logs can be viewing using: journalctl -u r3commission -n 100


---

# 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://docs.remote.it/software/bluetooth-wifi-onboarding-package-r3onboard.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.
