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

Write documentation on how to use btmon #122

Closed
aguaviva opened this issue Mar 31, 2021 · 4 comments
Closed

Write documentation on how to use btmon #122

aguaviva opened this issue Mar 31, 2021 · 4 comments

Comments

@aguaviva
Copy link

btmon is a tool that seems to help troubleshoot issues. I have seen a few maintainers ask casual developers to use it. However the documentation is pretty scarce, a thing that is a bit shocking and this is a barrier for many people that would like to participate and improve the repository.

@Vudentz
Copy link
Contributor

Vudentz commented Mar 31, 2021

I guess you want something like a hcidump manpage:

https://linux.die.net/man/8/hcidump

Note that btmon --hep giver a lot of this information:

btmon - Bluetooth monitor
Usage:
	btmon [options]
options:
	-r, --read <file>      Read traces in btsnoop format
	-w, --write <file>     Save traces in btsnoop format
	-a, --analyze <file>   Analyze traces in btsnoop format
	-s, --server <socket>  Start monitor server socket
	-p, --priority <level> Show only priority or lower
	-i, --index <num>      Show only specified controller
	-d, --tty <tty>        Read data from TTY
	-B, --tty-speed <rate> Set TTY speed (default 115200)
	-V, --vendor <compid>  Set default company identifier
	-M, --mgmt             Open channel for mgmt events
	-t, --time             Show time instead of time offset
	-T, --date             Show time and date information
	-S, --sco              Dump SCO traffic
	-A, --a2dp             Dump A2DP stream traffic
	-E, --ellisys [ip]     Send Ellisys HCI Injection
	-P, --no-pager         Disable pager usage
	-J  --jlink <device>,[<serialno>],[<interface>],[<speed>]
	                       Read data from RTT
	-R  --rtt [<address>],[<area>],[<name>]
	                       RTT control block parameters
	-h, --help             Show help options

@aguaviva
Copy link
Author

I already knew that, and that is not documentation.

There are a couple of bugs were you ask people to use btmon, it wouldn't hurt if you could add a bit of details explaining what to do exactly with it and what to look for, after all we are trying to help out.

@tedd-an
Copy link
Contributor

tedd-an commented Apr 15, 2021

I created a wiki page for btmon to start: https://github.com/bluez/bluez/wiki/btmon
We can add more content as we move on.

@Vudentz
Copy link
Contributor

Vudentz commented May 5, 2021

https://github.com/bluez/bluez/blob/master/monitor/btmon.rst

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants