Release/4.0.0

[bessman]

Summary by Sourcery

This release introduces a new connection module to handle different control interfaces, including a new WLANHandler for WLAN control. It also includes several breaking changes, such as moving and deprecating the serial_handler, and a fix for SPI configuration.

New Features:

• Add a common connection module for different control interfaces.
• Implement WLANHandler class for controlling the PSLab over WLAN.
• Introduce ConnectionHandler base class for SerialHandler and WLANHandler.
• Add connection.autoconnect function.
• Introduce instrument.buffer module.

Bug Fixes:

• Fix SPI configuration sending one byte too few.

Enhancements:

• Deprecate serial_handler in favor of connection.
• Move SerialHandler to connection.
• Move detect to connection.
• Make check_serial_access_permission private.
• Move ADCBufferMixin to instrument.buffer.

Chores:

• Update the version to 4.0.0.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces a new connection module to handle different control interfaces like Serial and WLAN. It also refactors the ADCBufferMixin to a dedicated module and includes breaking changes like removing SerialHandler.wait_for_data and changing the instantiation of SerialHandler. Finally, it updates the version number to 4.0.0.

Updated class diagram for connection module

classDiagram
    class ConnectionHandler {
        +connect()
        +disconnect()
        +send(data)
        +receive(length)
    }
    class SerialHandler {
        +port: str
        +baudrate: int
        +connect()
        +disconnect()
        +send(data)
        +receive(length)
    }
    class WLANHandler {
        +host: str
        +port: int
        +connect()
        +disconnect()
        +send(data)
        +receive(length)
    }

    ConnectionHandler <|-- SerialHandler
    ConnectionHandler <|-- WLANHandler
    note for ConnectionHandler "Base class for SerialHandler and WLANHandler"
    note for SerialHandler "Handles serial communication"
    note for WLANHandler "Handles WLAN communication"

Loading

Class diagram for ADCBufferMixin refactoring

classDiagram
    class ADCBufferMixin {
        +get_buffer_data()
        +configure_buffer()
    }

    note for ADCBufferMixin "Moved to instrument.buffer module"

Loading

File-Level Changes

Change	Details	Files
Introduces a common connection module for different control interfaces, including a ConnectionHandler base class for SerialHandler and WLANHandler.	Adds a connection module. Adds a ConnectionHandler base class. Moves SerialHandler to connection. Moves detect to connection. Adds WLANHandler class for controlling the PSLab over WLAN. Adds connection.autoconnect function.	CHANGELOG.md
Refactors the ADCBufferMixin to a dedicated instrument.buffer module.	Moves ADCBufferMixin to instrument.buffer. Adds instrument.buffer module.	CHANGELOG.md
Removes SerialHandler.wait_for_data and makes check_serial_access_permission private.	Removes SerialHandler.wait_for_data. Makes check_serial_access_permission private.	CHANGELOG.md
Updates the version number to 4.0.0.	Updates the version to 4.0.0.	pslab/__init__.py

---

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 @bessman - I've reviewed your changes - here's some feedback:

Overall Comments:

• The changelog entries are well-formatted and informative.
• Consider adding a brief summary of the changes in the description of the pull request.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 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.}