Skip to content

feature/spatial-analytics-documentation - Add spatial analytics developer guide#598

Merged
saratpoluri merged 9 commits intorelease-2025.2from
feature/spatial-analytics-documentation
Nov 24, 2025
Merged

feature/spatial-analytics-documentation - Add spatial analytics developer guide#598
saratpoluri merged 9 commits intorelease-2025.2from
feature/spatial-analytics-documentation

Conversation

@rawatts10
Copy link
Copy Markdown
Contributor

📝 Description

This PR adds comprehensive developer documentation for working with SceneScape's spatial analytics data, focusing on ROIs (Regions of Interest) and Tripwires. The documentation provides complete guidance for building applications that consume spatial analytics events from SceneScape's sensor-agnostic platform.

What was changed:

  • Added working-with-spatial-analytics-data.md (872 lines) - complete developer guide for spatial analytics
  • Added sample_region_tripwire.png - visual example from Intel HQ Santa Clara parking lot

Why it was needed:

  • Developers need comprehensive documentation to understand and consume spatial analytics events
  • Real-world examples help developers understand practical deployment scenarios
  • The sensor-agnostic architecture benefits were not well documented
  • Authentication patterns for different deployment scenarios needed clarification

How the changes add value:

  • Provides complete tutorial with Python and JavaScript examples ready to run
  • Documents all event data structures with detailed field descriptions
  • Explains multi-sensor advantages and sensor-agnostic architecture
  • Includes Intel HQ parking lot example showing real-world ROI and tripwire deployment

✨ Type of Change

Select the type of change your PR introduces:

  • 🐞 Bug fix – Non-breaking change which fixes an issue
  • 🚀 New feature – Non-breaking change which adds functionality
  • 🔨 Refactor – Non-breaking change which refactors the code base
  • 💥 Breaking change – Changes that break existing functionality
  • 📚 Documentation update
  • 🔒 Security update
  • 🧪 Tests
  • 🚂 CI

🧪 Testing Scenarios

Describe how the changes were tested and how reviewers can test them too:

  • ✅ Tested manually
    • Verified all code examples work with SceneScape deployment
    • Tested Python scripts (discover.py, listen.py) with live MQTT events
    • Validated JavaScript web example with WebSocket MQTT connection
    • Confirmed image rendering and file structure
  • 🤖 Ran automated end-to-end tests

Manual Testing Details:

  • Environment setup instructions tested on Ubuntu
  • REST API examples validated against SceneScape deployment
  • MQTT authentication patterns verified for both WebSocket and direct protocols
  • All tutorial examples run successfully and produce expected output
  • Documentation formatting and internal links verified

✅ Checklist

Before submitting the PR, ensure the following:

  • 🔍 PR title is clear and descriptive
  • 📝 For internal contributors: If applicable, include the JIRA ticket number (e.g., ITEP-123456) in the PR title. Do not include full URLs
  • 💬 I have commented my code, especially in hard-to-understand areas
  • 📄 I have made corresponding changes to the documentation
  • ✅ I have added tests that prove my fix is effective or my feature works

Additional Notes:

  • This is purely a documentation enhancement with working code examples
  • All examples include detailed explanations and are ready for immediate use by developers
  • The Intel HQ example provides real-world context that makes the concepts immediately understandable
  • No configuration or infrastructure changes included

- Updated Table of Contents item #4 to match actual section header
Copy link
Copy Markdown
Contributor

@kblaszczak-intel kblaszczak-intel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's is a really comprehensive article. I'd love to read it all and carefully but I can do it after it's merged. At first glance, it looks really solid.

Copy link
Copy Markdown
Contributor

@saratpoluri saratpoluri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The document needs to be in the toctree. Please also consider in which document it can go as a reference link.

Comment thread docs/user-guide/using-intel-scenescape/working-with-spatial-analytics-data.md Outdated
Comment thread docs/user-guide/using-intel-scenescape/working-with-spatial-analytics-data.md Outdated
Comment thread docs/user-guide/using-intel-scenescape/working-with-spatial-analytics-data.md Outdated
Comment thread docs/user-guide/using-intel-scenescape/working-with-spatial-analytics-data.md Outdated
- Add 'Working with Spatial Analytics Data' to toctree navigation
- Create cross-references between configuration and data consumption guides
- Add reference to object properties configuration guide
- Update curl examples to use environment variables
- Reorganize content structure for better logical flow
- Fix remote server access instructions for web examples

Addresses reviewer feedback on spatial analytics guide integration.
rawatts10 and others added 2 commits November 21, 2025 10:11
- Fix misleading description of 'objects' events (entry/exit only, not movement)
- Consolidate redundant event type explanations for better clarity
- Add cross-reference link to Streaming Data Topics section
- Remove incorrect reference to movement-based event triggering

Improves accuracy of MQTT event documentation.
@sgolebiewski-intel sgolebiewski-intel force-pushed the feature/spatial-analytics-documentation branch from e3822ff to 0ab24ac Compare November 24, 2025 10:42
@saratpoluri saratpoluri enabled auto-merge (squash) November 24, 2025 16:21
@saratpoluri saratpoluri disabled auto-merge November 24, 2025 16:21
@saratpoluri saratpoluri enabled auto-merge (squash) November 24, 2025 16:21
@saratpoluri saratpoluri merged commit ac34d01 into release-2025.2 Nov 24, 2025
24 of 25 checks passed
@saratpoluri saratpoluri deleted the feature/spatial-analytics-documentation branch November 24, 2025 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants