Skip to content

Enable transmit Emotibit Serial Number to oscilloscope#264

Merged
nitin710 merged 8 commits intomasterfrom
feat-txEmotiBitSrNum
Apr 6, 2023
Merged

Enable transmit Emotibit Serial Number to oscilloscope#264
nitin710 merged 8 commits intomasterfrom
feat-txEmotiBitSrNum

Conversation

@nitin710
Copy link
Collaborator

@nitin710 nitin710 commented Mar 21, 2023

Description

  • The EmotiBit now transmits EmotiBit Serial Number as a part of the HELLO_HOST packet.
  • This enables the Oscilloscope to display discovered EmotiBits with serial numbers and not IPs

Requirements

To Test

Issues Referenced

  • None

Documentation update

  • None

Testing

Test Configuration:

  • Firmware version: 1.7.0.feat-txEmotibitSrNum.1
  • Hardware: EmotiBit V5
  • EmotiBit software version: 1.7.2.fix-tempPlotTimeScale.0.feat-emotibitDeviceId.1

Tested conditions

- Old FW New FW
Old SW ✔️ (EmotiBit represented with IPs) ✔️ (EmotiBit represented with IPs)
New SW ✔️(EmotiBit represented with IPs) ✔️ (EmotiBit represented with serial numbers)
  • ✔️ Tested with single and multiple EmotiBits
  • ❓ Not tested with v2 EmotiBits

Testing Notes

  • EmotiBits v2/v3 have no serial number visible on the EmotiBit itself.
    • It is derived from the Si7013 sensor.
  • As a consequence the EmotiBits show up as "seemingly random" numbers.
    • image
  • This is the expected behavior as per the code. If we think that it rather makes sense to have v2/v3 represented by an IP address, then we can roll that change in a future PR.

To Perform Testing:

  • Flash your Feather with this 1.7.0.feat-txEmotibitSrNum.1.zip
  • Compile an run the new oscilloscope linked in the PR above. (Make sure to pull the appropriate XPlat dependency)
  • Notice the EmotiBit name in the device list. The EmotiBits should be listed by their Serial Number.

Checklist to allow merge

  • All dependent repositories used were on branch master
    • Excluding dependencies getting updated
  • Firmware
    • Set testingMode to TestingMode::NONE
    • Set const bool DIGITAL_WRITE_DEBUG = false (if set true while testing)
    • Update version in EmotiBit.h
    • Update library.properties to the correct version (should match EmotiBit.h)
  • doxygen style comments included for new code snippets
  • Required documentation updated

Screenshots:

image

@nitin710 nitin710 changed the title Enable transmit emotibit Serial Number to oscilloscope Enable transmit Emotibit Serial Number to oscilloscope Mar 21, 2023
Copy link
Collaborator

@produceconsumerobot produceconsumerobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review 01

Code review complete
Testing TBD

@produceconsumerobot
Copy link
Collaborator

produceconsumerobot commented Apr 6, 2023

Review 02

  • Looks good! Tested in 2x2x2 matrix: Old/New FW, Old/New Oscilloscope, ESP/M0 and everything worked.

New Oscilloscope
image
Old Oscilloscope
image

@nitin710 be sure to turn off verbose logging in the FW and SW and then go ahead and merge.

@nitin710
Copy link
Collaborator Author

nitin710 commented Apr 6, 2023

Merging to master

@nitin710 nitin710 merged commit e4ac5fc into master Apr 6, 2023
@nitin710 nitin710 deleted the feat-txEmotiBitSrNum branch April 6, 2023 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants