Skip to content

Commit db39cc6

Browse files
README.md - add note about max advert limit
1 parent 71be962 commit db39cc6

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,15 @@ Sorry. Although [BTHome offers encrypted communication](https://bthome.io/encryp
5757
## Can it do more than temperature and humidity?
5858
My goal was to create an outdoor sensor to measure temperature, humidity, and illuminance so I could make automation decsions in Home Assistant. I've included nearly the entire list of object_ids described in the [BTHome v2 format](https://bthome.io/format), but those outside of temperature, humidity, and battery level are untested in real world scenarios.
5959

60+
## What caveats should I be aware of?
61+
The number of bytes reserved for BLE advertising is extremely limited. If you try to pack too much data, you'll get an exception.
62+
63+
```
64+
ValueError: BLE advertisement exceeds max length
65+
```
66+
67+
If this happens, use the debugging output to determine the length of your advertising payload. You may be able to shorten the device name or limit the number of object IDs you're communicating to make it fit.
68+
6069
## How can I help?
6170
Test, test, test! I'm always happy to get bug reports in the [GitHub issues for the project](https://github.com/DavesCodeMusings/BTHome-MicroPython/issues). The more detail you give, the easier it is to find and fix.
6271

0 commit comments

Comments
 (0)