Added advertising control to set unicast pacing

[produceconsumerobot]

Description

Advertising is on a separate thread and has timers that can be set in emotibitCommsSettings.json

Requirements

• none

Issues Referenced

• closes #173

Documentation update

Documentation update is short-term optional, but needs to be added to the roadmap

Testing

• [x] sendAdvertisingInterval_msec changes advertising interval (OF_LOG_VERBOSE)
• [x] unicastMinLoopDelay_msec changes unicastMinLoopDelay (OF_LOG_VERBOSE)
• [x] nUnicastIpsPerLoop changes nUnicastIpsPerLoop (OF_LOG_VERBOSE)
• [x] checkAdvertisingInterval_msec changes checkAdvertisingInterval (OF_LOG_VERBOSE)
• [x] Works with multiple networks (e.g. virtual machines)
• [x] Works with wifi routers that throttle unicast spamming
• [x] Works with multiple EmotiBits on the network

Checklist:

• [x] All dependent repositories used were on branch master
• [ ] Release checklist completed (FW/ SW)
  • Make sure the required settings have been set to default before merging into master.
• [x] doxygen style comments included
• [ ] Required documentation updated

Screenshots:

[nitin710]

testing on windows

• [x] sendAdvertisingInterval_msec changes advertising interval (OF_LOG_VERBOSE)
  • Tested with delay 2000
  • [x] broadcast
  • [x] unicast
  • observed delay (because of sendAdvertisingInterval_msec) between cycling through ip addresses
• [ ] unicastMinLoopDelay_msec changes unicastMinLoopDelay (OF_LOG_VERBOSE)
  • setting this to 50, somehow creates delays > 60mS
  • 
• [x] nUnicastIpsPerLoop changes nUnicastIpsPerLoop (OF_LOG_VERBOSE)
  • Verified. changed value to 1,5 10 and observed the output
• [x] checkAdvertisingInterval_msec changes checkAdvertisingInterval (OF_LOG_VERBOSE)
  • Tested with 100,200.
  • Saw some deviation @200 with times ranging from 200mS-215mS
• [x] Works with multiple network adapters
• [ ] ~Works with wifi routers that throttle unicast spamming~
• [x] Works with multiple EmotiBits on the network
  • 

[nitin710]

testing on macos

• [x] sendAdvertisingInterval_msec changes advertising interval (OF_LOG_VERBOSE)
  • Tested with delay 2000
  • [x] broadcast
  • [x] unicast
  • observed delay (because of sendAdvertisingInterval_msec) between cycling through ip addresses
• [x] unicastMinLoopDelay_msec changes unicastMinLoopDelay (OF_LOG_VERBOSE)
  • verified by testing a delay of 50. got 50 consistently
• [x] nUnicastIpsPerLoop changes nUnicastIpsPerLoop (OF_LOG_VERBOSE)
  • Verified. changed value to 10 and observed the output
• [x] checkAdvertisingInterval_msec changes checkAdvertisingInterval (OF_LOG_VERBOSE)
  • Tested with 100, 200.
• [x] Works with multiple network adapters
  • verified working with vpn subnet as a part of available subnets
• [ ] ~Works with wifi routers that throttle unicast spamming~
• [x] Works with multiple EmotiBits on the network

[nitin710]

bug fix https://github.com/EmotiBit/ofxEmotiBit/commit/a3d2d9b5b426b0d52c20a58be1ec97ff349ac255 Weird behavior found: with

          "enabled": true,
          "ipMax": 254,
          "ipMin": 250,
          "nUnicastIpsPerLoop": 3,
          "unicastMinLoopDelay_msec": 50

The unicast is missing pinging certain IP addresses. notice below, xxx.xxx.xxx.250 is missed in attempt 2, and xxx,xxx,xxx,250 $ xxx,xxx,xxx,251 are missed in attempt 3

[nitin710]

testing on linux

• [x] sendAdvertisingInterval_msec changes advertising interval (OF_LOG_VERBOSE)
  • Tested with delay 2000
  • [x] broadcast
  • [x] unicast
  • observed delay (because of sendAdvertisingInterval_msec) between cycling through ip addresses
• [x] unicastMinLoopDelay_msec changes unicastMinLoopDelay (OF_LOG_VERBOSE)
  • verified by testing a delay of 50. got 50 consistently
• [x] nUnicastIpsPerLoop changes nUnicastIpsPerLoop (OF_LOG_VERBOSE)
  • Verified. changed value to 10 and observed the output
• [x] checkAdvertisingInterval_msec changes checkAdvertisingInterval (OF_LOG_VERBOSE)
  • Tested with 100, 200.
• [ ] ~Works with multiple network adapters~
• [ ] ~Works with wifi routers that throttle unicast spamming~
• [x] Works with multiple EmotiBits on the network

[nitin710]

bug fix explanation for https://github.com/EmotiBit/ofxEmotiBit/pull/174/commits/a3d2d9b5b426b0d52c20a58be1ec97ff349ac255

case

"ipMax": 254,
"ipMin": 250,
"nUnicastIpsPerLoop": 3,

after reaching ip: 254, the variable is updated sendInProgress = false; which disables advertisement.	Cycle\IP address	250	251	252	253	254	250	251	252
0	tx	tx	tx	-	-	-	-
1	-	-	-	tx	tx	no tx	-
2	-	tx	tx	tx	-	-
3	-	-	-	-	tx	no tx	no tx
4	-	-	tx	tx	tx