Puara / puara-module-templates

Template for crating music controllers using the Puara framework
0 stars 4 forks source link

[BLE-advertising-template] - There appears to be no way(yet) to set the name of a bluetooth advertiser in the template #2

Open satmatthills opened 1 month ago

satmatthills commented 1 month ago

Summary: There appears to be no way(yet) to set the name of a bluetooth advertiser in the template, though other bluetooth advertising templates include one. Potentially it exists but is not documented?

Steps to Reproduce:

  1. Flash your firmware
  2. Try to find your device

Actual Results: Your device joins the millions of bluetooth signals without a distinguishing label to know which one is yours

Expected Results: Being able to change the name will undoubtedly help when more than one device is in the area.

guillaumeriousat commented 5 days ago

Normally, the advertiser name should be the name of your puara device. This is configurable in the config.json file that you can flash to the filesystem of the device. You should see the name you put in the device field plus the id you put in the id field.

I remember seeing this work when I was implementing the BLE template but I didn't test again.

satmatthills commented 3 days ago

Ok, I found the config.json file and it does look like those settings should do the trick. The default settings are obvious enough that, on the contrary, I simply haven't succeeded in making my device broadcast yet.

On the other hand, the documentation makes no mention of the config.json file; it instead implies that all necessary configuration should be done in the platform.io file... is it possible to break this setting into the platform.io / intial setup workflow instead?

Otherwise, we should update the documentation; before writing this issue I asked both @edumeneses and sarah and neither were able to find the setting.

jcelerier commented 3 days ago

on the contrary, I simply haven't succeeded in making my device broadcast yet.

since we had the same problem today with another device: did you check that an antenna is plugged on the device ?

satmatthills commented 3 days ago

There was indeed no antenna; it was an esp32-c3-devkit… wasn’t aware it needed an antenna until just now!

edumeneses commented 2 days ago

About the documentation: they should live in puara-module IMO, and the templates should be self-documented through comments in the code.