Skip to content

Add example scripts for common use cases#8

Open
Tiago-Vier-Preto wants to merge 1 commit into
rudra496:masterfrom
Tiago-Vier-Preto:docs/add-example-scripts-for-common-use-cases
Open

Add example scripts for common use cases#8
Tiago-Vier-Preto wants to merge 1 commit into
rudra496:masterfrom
Tiago-Vier-Preto:docs/add-example-scripts-for-common-use-cases

Conversation

@Tiago-Vier-Preto
Copy link
Copy Markdown

Description

Added an examples/ directory containing sample Python scripts demonstrating how to integrate various edge AI and machine learning tasks with the EdgeBrain platform via MQTT. The following examples were added:

  1. image_classification.py - Simulates a Raspberry Pi running an image classification model.
  2. object_detection.py - Simulates a webcam running an object detection model (e.g., YOLO) to count persons.
  3. sentiment_analysis.py - Demonstrates text-based AI integration by performing sentiment analysis and publishing the score.
    Also included an examples/README.md to guide users on how to run these scripts.

Fixes #7

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactor (no functional changes)

Testing

  • docker compose up --build succeeds
  • Dashboard loads at http://localhost:3000
  • API returns data at http://localhost:8000/api/v1/devices
  • New/modified code is tested (Reviewed the generated example scripts to ensure they use correct paho-mqtt syntax and match EdgeBrain's expected payload structure).

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code where necessary
  • I have updated the documentation if needed
  • My changes generate no new warnings

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.

good first issue: Add example scripts for common use cases

1 participant