Broadcom / AFBR-S50-API

API for the AFBR-S50 Time-Of-Flight Sensor Family.
https://www.broadcom.com/products/optical-sensors/time-of-flight-3d-sensors
BSD 3-Clause "New" or "Revised" License
23 stars 6 forks source link

Explorer app reference manual is incorrect about the bit width of frame state #31

Closed mfreed7 closed 2 months ago

mfreed7 commented 2 months ago

The docs for measurement data output (in all modes) say that the "Measurement Frame State Flags" are a HEX16 taking 2 bytes. But in practice (see code links below) that's a 4-byte wide field.

Docs: https://broadcom.github.io/AFBR-S50-API/explorer_app_cmd_details.html#:~:text=Measurement%20Data%20Set%20(1D%20%2B%203D)%20%2D%20Debug

Code: https://github.com/Broadcom/AFBR-S50-API/blob/main/Sources/ExplorerApp/api/explorer_api_data.c#L79

The reference for argus_state_t does show 32 bits, but it'd be nice if the tables in the section above reflected that: https://broadcom.github.io/AFBR-S50-API/group__argus__dca.html#gada1413643a68f3cd36f6c0a1d0b61e91

mfreed7 commented 2 months ago

Fixed in https://github.com/Broadcom/AFBR-S50-API/pull/32

c-berger commented 2 months ago

Thanks for catching that!