feat: add NIC specific part of MAC address as suffix to SSID

[marcnause]

The last six bytes of the device specific MAC address of the ESP01 will be used as a suffix for the SSID.

This feature will make it easier to tell the WiFis of PSLab devices apart. Might be useful when running a workshop.

Summary by Sourcery

Modify WiFi SSID generation to include the device-specific part of the MAC address as a unique suffix

New Features:

• Add a unique suffix to the WiFi SSID based on the last six bytes of the device's MAC address

Enhancements:

• Implement a method to extract and format the device-specific MAC address for SSID differentiation

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces a feature that appends a suffix, derived from the device's MAC address, to the SSID. This change helps distinguish between multiple PSLab devices' WiFis, particularly in workshop settings. The implementation involves a new getSuffix() function to generate the suffix and modification of the WiFi.softAP() call to include it.

Sequence diagram for WiFi softAP setup with MAC address suffix

sequenceDiagram
  participant ESP01Firmware
  participant WiFi

  ESP01Firmware->>ESP01Firmware: setup()
  ESP01Firmware->>ESP01Firmware: getSuffix()
  ESP01Firmware-->>WiFi: macAddress()
  WiFi-->>ESP01Firmware: MAC Address
  ESP01Firmware->>ESP01Firmware: Remove vendor ID and colons from MAC Address
  ESP01Firmware-->>ESP01Firmware: Suffix
  ESP01Firmware->>WiFi: softAP(ssid + suffix, password)
  WiFi-->>ESP01Firmware: WiFi AP started

Loading

File-Level Changes

Change	Details	Files
Implemented a function to generate a suffix for the SSID based on the device's MAC address and appended it to the SSID.	Added a getSuffix() function to extract the last six bytes of the MAC address, remove colons, and prepend an underscore. Modified the WiFi.softAP() call to include the generated suffix in the SSID.	src/ESP01Firmware/ESP01Firmware.ino

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @marcnause - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding a compile-time flag to enable/disable this feature.
• Consider adding a unit test for the getSuffix function.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[AsCress]

@marcnause Maybe we could also update the docs in scope of this PR ? Precisely here:

pslab-esp01-firmware/docs/esptool.md

Line 91 in c2a796f

Now pull the ESP-01's GPIO_0 pin high and reset it. If the new firmware was flashed successfully, it will start broadcasting an SSID called "PSLab".

[bessman]

We haven't adopted a style for this project yet, but the following is my preference. It's what I'm using in pslab-firmware.

[marcnause]

@AsCress @bessman Thank you for your suggestions. I have added them.