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

20220327 Home Assistant documentation #528

Merged

Conversation

Paraphraser
Copy link

Repairs broken internal hyperlinks by restoring internal anchors.

Restored anchors converted to null-anchor form.

Fixes some spacing and alignment errors (apparent in MacDown authoring
tool).

Prefers multi-line command syntax over && form which can be confusing
to new users (quasi standard followed in other IOTstack documentation).

Prefers $ prompt form for commands users should execute. This is
another quasi-standard.

Explicitly sets cd ~/IOTstack where its omission might produce
unexpected results.

Adds code-fence rendering hints where appropriate.

Signed-off-by: Phill Kelley 34226495+Paraphraser@users.noreply.github.com

Repairs broken internal hyperlinks by restoring internal anchors.

Restored anchors converted to null-anchor form.

Fixes some spacing and alignment errors (apparent in MacDown authoring
tool).

Prefers multi-line command syntax over `&&` form which can be confusing
to new users (quasi standard followed in other IOTstack documentation).

Prefers `$ ` prompt form for commands users should execute. This is
another quasi-standard.

Explicitly sets `cd ~/IOTstack` where its omission might produce
unexpected results.

Adds code-fence rendering hints where appropriate.

Signed-off-by: Phill Kelley <34226495+Paraphraser@users.noreply.github.com>
…tack

Signed-off-by: Phill Kelley <34226495+Paraphraser@users.noreply.github.com>
Signed-off-by: Phill Kelley <34226495+Paraphraser@users.noreply.github.com>
@ukkopahis
Copy link

Not strictly part of your changes, but wouldn't this be better if changed to "sudo hciconfig" (and of course to use the console highlighter):

After a reboot, check that BT is up:
```sh
(root) # hciconfig
...
UP
...
```

@Paraphraser
Copy link
Author

Paraphraser commented Apr 19, 2022

Can't really say. I didn't write that bit. Something about Bluetooth, isn't it? History has it added by Tzaphkiel.

@ukkopahis
Copy link

ukkopahis commented Apr 19, 2022

I'm suggesting this change as (root) # isn't really beginner-friendly. Elsewhere in the documentation $ sudo <root cmd> is used, so should by changed for better consistency, too.

I can make it a new pull-request, or could you just add the change here to your pull-request? Both are fine to me, just feels like it would better fit here as part of all the other changes. (And also change sh->console)

@Paraphraser
Copy link
Author

No, I'll do it. I suppose the point I was trying to make (in my own incredibly clumsy manner) was that I didn't actually understand what that documentation snippet was trying to communicate and, as a rule, I'm not a fan of jumping in and rewriting stuff I don't understand. I should've said that rather than leaving it implied in the "I didn't write it". My bad.

After a bit more digging, it (root) turns out not to be necessary. The issue being addressed is if AutoEnable=true isn't set then Bluetooth will not be enabled at boot so that is something to be checked by running:

$ hciconfig
hci0:   Type: Primary  Bus: UART
        BD Address: DC:89:FB:A6:32:4B  ACL MTU: 1021:8  SCO MTU: 64:1
        UP RUNNING 
        RX bytes:2003 acl:0 sco:0 events:159 errors:0
        TX bytes:11583 acl:0 sco:0 commands:159 errors:0

and looking for the "UP". It's probably a bit back-to-front. I'll rewrite it as check then, if necessary: fix, reboot, recheck.

Funny thing, though, I've never yet found a single use for the Bluetooth interface on any Pi. What about you?

Signed-off-by: Phill Kelley <34226495+Paraphraser@users.noreply.github.com>
@Paraphraser
Copy link
Author

Done.

Signed-off-by: Phill Kelley <34226495+Paraphraser@users.noreply.github.com>
@Slyke Slyke merged commit 3c19fe2 into SensorsIot:master Apr 26, 2022
@Paraphraser Paraphraser deleted the 20220327-homeassistant-doco-master branch April 26, 2022 12:41
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

Successfully merging this pull request may close these issues.

None yet

3 participants