Skip to content

Update audio classification doc #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 5, 2025
+3 −3
Merged

Update audio classification doc #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions examples/audio-classification/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ The glass breaking sensor example uses the following Bricks:

- Arduino App Lab

**Note:** You can also run this example using your Arduino UNO Q as a Single Board Computer (SBC) using a [USB-C hub](https://store.arduino.cc/products/usb-c-to-hdmi-multiport-adapter-with-ethernet-and-usb-hub) with a mouse, keyboard and display attached.
**Note:** This example works with pre-loaded sample audio files and uploaded audio files. No external hardware peripherals are required. The example works in [Network Mode](https://docs.arduino.cc/tutorials/uno-q/user-manual/#network-mode) as well.

## How to Use the Example

1. Run the App

![Run the App](assets/docs_assets/launch-app.png)

2. The App should open automatically in the web browser. You can open it manually via `<board-name>.local:7000`.
2. The App should open automatically in the web browser. You can also open it manually via `<board-name>.local:7000` or `http://<board-ip-address>:7000` (Network Mode).
3. Choose your audio input method:

- **Audio from sample**: Select from pre-loaded sample audio files (includes glass breaking examples and background noise)
Expand Down Expand Up @@ -125,7 +125,7 @@ Here is a brief explanation of the application components:

The Python® component handles audio classification and web service functionality.

- **`AudioClassification` integration**: Initializes the audio classification model with lazy loading and fallback mock microphone support for file-based classification scenarios.
- **`AudioClassification` integration**: Initializes the audio classification model for file-based classification. The example processes pre-recorded audio files (uploaded or from samples).

- **`parse_data()` function**: Handles WebSocket message parsing, supporting both JSON string and dictionary formats for flexible client communication.

Expand Down