Acoustic comms : Packet collision timeout

[adityapande-1995]

🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸

🎉 New feature

Summary

This PR adds a new tag <collision_time_interval> to the acoustic comms plugin. If an address endpoint receives two data packets within that time interval, the second one will be dropped. The timeout value defaults to zero, so no packets are ever dropped if the tag is unspecified.

The time must be in seconds.

Test it

Added an integration test using acoustic_comms_packet_collision.sdf. If multiple packets are sent during a 1 second time interval, they will be dropped. In the test, I send 3 packets, and only the first one of them is received.

Checklist

• Signed all commits for DCO
• Added tests
• Added example and/or tutorial
• Updated documentation (as needed)
• Updated migration guide (as needed)
• Consider updating Python bindings (if the library has them)
• codecheck passed (See contributing)
• All tests passed (See test coverage)
• While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸

[codecov]

Codecov Report

Merging #1755 (061b93b) into gz-sim7 (c4cd2c0) will increase coverage by 0.00%.
The diff coverage is 95.83%.

@@           Coverage Diff            @@
##           gz-sim7    #1755   +/-   ##
========================================
  Coverage    64.19%   64.20%           
========================================
  Files          336      336           
  Lines        26830    26853   +23     
========================================
+ Hits         17224    17241   +17     
- Misses        9606     9612    +6     

Impacted Files	Coverage Δ
src/systems/acoustic_comms/AcousticComms.cc	95.12% <95.83%> (+1.90%)	⬆️
src/SimulationRunner.cc	91.32% <0.00%> (-0.95%)	⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[hidmic]

LGTM, but I don't follow what phenomena we are trying to model here.

[arjo129]

Seems reasonable to me. However, I would encourage us to actually allow users to set a "bit-rate" so that the packet collision also depends on the length of the packet. I don't believe this is too much extra work but would lead to a much more realistic
and usable model.

[adityapande-1995]

I'm pretty sure this is not breaking ABI, but the ABI checker is failing weirdly.

[mjcarroll]

I'm pretty sure this is not breaking ABI, but the ABI checker is failing weirdly.

ABI checker is having some issues at the moment.