Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add bluetooth documentation #79

Merged
merged 8 commits into from
Oct 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions src/devel/device/bluetooth.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
=========
Bluetooth
=========

The reMarkable 1 and 2 do not have bluetooth. The reMarkable Paper Pro does have bluetooth hardware, but the driver is not loaded by default.

Enabling bluetooth
------------------

.. code-block:: shell

modprobe btnxpuart
bluetoothctl show


:raw-html:`<div class="warning">⚠️ FIXME. ⚠️`

This page is just a stub that needs to be completed. You can `open a PR on the repo <https://github.com/Eeems-Org/remarkable.guide>`_ to add more content to the page.
:raw-html:`</div>`


Connecting a Device
-------------------

.. code-block:: shell

bluetoothctl

This will drop you into an interactive prompt for running bluetoothctl commands.

.. code-block:: shell
power on
scan on
# Wait for the mac address for the device you are interested to show up
pair <mac-address>
# You will be prompted to enter a PIN code for the device
connect <mac-address>
trust <mac-address>


External Links
==============

- ArchWiki article on Bluetooth
https://wiki.archlinux.org/title/Bluetooth
- Kernel Module documentation in the i.MX knowledge base
https://community.nxp.com/t5/i-MX-Processors-Knowledge-Base/Bluetooth-NXP-UART-Driver-Linux-BSP-6-1-22-btnxpuart/ta-p/1708588
- Documentation for bluetoothctl and related commands
https://man.archlinux.org/listing/extra/bluez-utils/
3 changes: 3 additions & 0 deletions src/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ automagic
backgrounded
backupscrns
behaviour
bluetooth
bluetoothctl
bugfixes
Carta
changescrn
Expand Down Expand Up @@ -51,6 +53,7 @@ linux
lockscreen
Memfault
multitouch
MX
nc
nuitka
pdfs
Expand Down
Loading