OnionIoT / tau-lidar-server

Python package for Tau Lidar Camera application
MIT License
27 stars 7 forks source link

User can access help + instructions #9

Closed greenbreakfast closed 3 years ago

greenbreakfast commented 3 years ago

User Story

  1. User starts TauLidarServer and navigates to web-based point-cloud viewer
  2. User clicks on Help button in the sidebar
  3. Observe modal shows up with:
    • description of what each control/button on the sidebar is for
    • how to pan, rotate, and zoom the point-cloud
    • where to go for general discussion about the Tau - link to Tau category on Onion Community Forum
    • Submit bug report or feature request - link to tau-lidar-server github issue page
    • Build your own programs for the Tau Camera - link to example folder in tau-lidar-camera repo on github
    • web viewer version number
  4. User clicks anywhere outside of modal, observe help modal closes
greenbreakfast commented 3 years ago

For initial release, changing help content to only show:

Copy for the content below:


Working with the Point cloud

You can rotate, pan, and zoom the point cloud to get the exact vantage point you need:

🌐 3D Rotate - Click and drag ↔️ 2D Pan - Right-click and drag 🔍 Zoom - Scroll up and down

The Sidebar Controls

should have same icon beside each help point

The sidebar controls let you adjust the point cloud as well as camera settings

Play | Pause - Stop/resume the real-time depth data stream from the Tau Camera. When stopped, the point cloud will show the last frame. Reset Point Cloud - Reset the point cloud orientation and zoom Auto Rotate Scene - Enable/disable automatic rotation of the point cloud

Change Point Size - Increase or decrease the size of each pixel in the point cloud

Color Range - Adjust the depth-based coloring of the point cloud 3D Integration Time - Adjust the duration of time the sensor collects light data, similar to exposure time on a regular camera. Higher integration time will result in more detailed data.

mh1412 commented 3 years ago

Implementation plan

  1. Add an extra help button in the UI control section of the app (top left corner of the screen)
  2. When user clicks the help button a modal will show up displaying help content
  3. User can click the on "x" or "close" buttons on the model to close it

Bug report feature moved to #10