feat: initialized Oscilloscope Screen

[AsCress]

Slowly and steadily, we would get there 🥹.
This is currently a Work In Progress.
Initializes the Oscilloscope Screen in our flutter app.

Screenshots / Recordings

N/A

The layouts are done, functionality coming soon.

Checklist:

• No hard coding: I have used resources from strings.xml, dimens.xml and colors.xml without hard coding any value.
• No end of file edits: No modifications done at end of resource files strings.xml, dimens.xml or colors.xml.
• Code reformatting: I have reformatted code and fixed indentation in every file included in this pull request.
• No extra space: My code does not contain any extra lines or extra spaces than the ones that are necessary.

@marcnause Would you like to test these layouts 😉 ?

Summary by Sourcery

Initialize the oscilloscope screen layouts.

New Features:

• Added layouts for the oscilloscope screen in the Flutter app.

Tests:

• Precached images for instrument icons and navigation header logo.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request initializes the Oscilloscope Screen in the Flutter app. It includes the basic layouts and integrates necessary providers for managing the board and oscilloscope states. The changes also involve updating dependencies and configuring USB device filters for Android.

Class diagram for the Oscilloscope Screen components

classDiagram
    class OscilloscopeScreen {
        +build()
        -setLandscapeOrientation()
    }
    class OscilloscopeStateProvider {
        -selectedIndex: int
        -yAxisScale: double
        -timebaseDivisions: int
        +timebaseSlider: double
        +isCH1Selected: bool
        +isCH2Selected: bool
        +isCH3Selected: bool
        +isMICSelected: bool
        +initialize()
        +setYAxisScale()
        +setTimebaseDivisions()
        +setTimebase()
        +createLineBarsData()
    }
    class ChannelParametersWidget {
        +build()
    }
    class TimebaseTriggerWidget {
        +build()
    }
    class DataAnalysisWidget {
        +build()
    }
    class XYPlotWidget {
        +build()
    }
    class OscilloscopeGraph {
        +build()
    }
    OscilloscopeScreen --> OscilloscopeStateProvider
    OscilloscopeScreen --> ChannelParametersWidget
    OscilloscopeScreen --> TimebaseTriggerWidget
    OscilloscopeScreen --> DataAnalysisWidget
    OscilloscopeScreen --> XYPlotWidget
    OscilloscopeScreen --> OscilloscopeGraph

Loading

Class diagram for the Communication components

classDiagram
    class ScienceLab {
        +connect()
        +isConnected()
        +getVersion()
        +captureTraces()
        +fetchTrace()
        +setGain()
        +loadEquation()
    }
    class PacketHandler {
        -buffer: Uint8List
        -connected: bool
        +getVersion()
        +sendByte()
        +sendInt()
        +getAcknowledgement()
        +getByte()
        +getInt()
    }
    class AnalogAcquisitionChannel {
        -resolution: int
        -timebase: double
        +length: int
        +bufferIndex: int
        +yAxis: List~double~
        +fixValue()
        +setParams()
        +regenerateXAxis()
    }
    class DigitalChannel {
        +channelName: String
        +channelNumber: int
        +length: int
        +loadData()
        +generateAxes()
    }
    ScienceLab --> PacketHandler
    ScienceLab --> AnalogAcquisitionChannel
    ScienceLab --> DigitalChannel

Loading

File-Level Changes

Change	Details	Files
Introduced the Oscilloscope Screen and its basic layout.	Created the OscilloscopeScreen widget with a basic structure. Implemented the layout for the oscilloscope screen, including graph and control sections. Added widgets for channel parameters, timebase trigger, data analysis, and XY plot settings. Created OscilloscopeGraph widget to display the graph. Created OscilloscopeScreenTabs widget for tabs.	lib/main.dart lib/view/oscilloscope_screen.dart lib/view/widgets/oscilloscope_graph.dart lib/view/widgets/oscilloscope_screen_tabs.dart lib/view/widgets/channel_parameters_widget.dart lib/view/widgets/timebase_trigger_widget.dart lib/view/widgets/data_analysis_widget.dart lib/view/widgets/xyplot_widget.dart
Integrated provider for managing board and oscilloscope states.	Added BoardStateProvider and OscilloscopeStateProvider to manage application state. Configured MultiProvider in main.dart to provide the state to the application. Created locator.dart to setup get_it for dependency injection. Initialized BoardStateProvider in main.dart.	lib/main.dart lib/providers/board_state_provider.dart lib/providers/oscilloscope_state_provider.dart lib/providers/locator.dart
Updated dependencies and configurations.	Added dependencies for provider, usb_serial, get_it, flutter_audio_capture, data, permission_handler, and fl_chart. Configured USB device filters in AndroidManifest.xml to recognize the PSLab device. Added microphone permission to AndroidManifest.xml. Added device_filter.xml to res/xml folder.	pubspec.yaml android/app/src/main/AndroidManifest.xml android/app/src/main/res/xml/device_filter.xml
Modified Instruments Screen to navigate to Oscilloscope Screen.	Added onTap to ApplicationsListItem to navigate to Oscilloscope Screen. Modified InstrumentsScreen to navigate to Oscilloscope Screen.	lib/view/instruments_screen.dart
Refactored CommonScaffold to MainScaffold and CommonScaffold.	Created MainScaffold widget to include navigation drawer. Created CommonScaffold widget to include back navigation. Modified InstrumentsScreen to use MainScaffold.	lib/view/widgets/common_scaffold_widget.dart lib/view/widgets/main_scaffold_widget.dart

---

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.

[github-actions]

Build successful. APKs to test: https://github.com/fossasia/pslab-android/actions/runs/13139653631/artifacts/2535042799

[marcnause]

Looks good on my device!

[AsCress]

@marcnause This PR now sets up communication with the PSLab device, and basic initialisation of the board. You should be able to see the version string when you connect to the board 🥳.
You may test with the APK provided by the comment pipeline, it is now updated.

[marcnause]

I tested with the latest version. I did not see any difference in the oscilloscope screen. Connecting the PSLab v5 and the PSLab v6 seems to work. With the v5 board I get a warning, for the v6 board I don't see the version. If I switch to the oscilloscope and back, the size of the navigation drawer changes on my device.

[marcnause]

for the v6 board I don't see the version.

This was my fault. I still had the UART-hack FW running on my PSLab v6.

[AsCress]

Just installed the legacy firmware on my v6 device. Everything works perfectly.

All these observations are pointing towards a single thing: the USB Serial driver that we are using may not properly support the MCP2200 USB-UART (CDC-ACM driver) converter that the v5 uses, the same issue which we had in our native app.
Looks like I may have to write a custom USB Serial library tailored to the PSLab 😢.
Let's get to that on a later stage at this is something already done in the native app and just requires a port to flutter, and let's continue our testing with the v6 device.

[sourcery-ai]

Hey @AsCress - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

• numBytesRead is never incremented in read() method (link)

Overall Comments:

• Consider adding error handling and loading states for device communication operations to improve reliability and user experience
• The signal processing algorithms would benefit from documentation explaining the mathematical approaches being used

Here's what I looked at during the review

• 🔴 General issues: 1 blocking issue, 1 other issue
• 🟢 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]

@adityastic @marcnause This PR is now ready from my side for a final review.
Sorry for such a large PR. I'll try to keep the PRs short from now on.

What works

1. The Oscilloscope with only the In-Built MIC feature.
2. Range Selection for the Y-Axis.
3. Time base selection for the X-Axis.

What doesn't work as of yet

1. CH1, CH2, CH3 or the PSLab MIC.
2. Triggering, Auto-Scale or Automated Measurements.
3. Recording of Oscilloscope data.
4. Any other feature which isn't listed in the above section.

These features would be added soon in upcoming PRs.

Demo of the Oscilloscope

Screen_recording_20250204_211716.mp4

@marcnause Can you please test the Oscilloscope and confirm if it works fine ? As usual, you can use the APK from the comment pipeline.