# bb_liveview v0.2.7 - Table of Contents

> Interactive LiveView-based dashboard for Beam Bots-powered robots.

## Pages

- [README](readme.md)
- [Change Log](changelog.md)

- Tutorials
  - [Your First Dashboard](01-your-first-dashboard.md)

- How-to Guides
  - [How to Customise Dashboard Layout](customise-dashboard-layout.md)

## Modules

- [BB.LiveView](BB.LiveView.md): Interactive LiveView-based dashboard for Beam Bots-powered robots.
- [BB.LiveView.Components](BB.LiveView.Components.md): Shared UI components for the BB Dashboard.
- [BB.LiveView.Components.Command](BB.LiveView.Components.Command.md): LiveComponent for executing robot commands.
- [BB.LiveView.Components.EventStream](BB.LiveView.Components.EventStream.md): LiveComponent for displaying a live stream of BB messages.
- [BB.LiveView.Components.JointControl](BB.LiveView.Components.JointControl.md): LiveComponent for controlling robot joint positions.
- [BB.LiveView.Components.Parameters](BB.LiveView.Components.Parameters.md): LiveComponent for viewing and editing robot parameters.
- [BB.LiveView.Components.Safety](BB.LiveView.Components.Safety.md): LiveComponent for displaying and controlling robot arming state.
- [BB.LiveView.Components.Visualisation](BB.LiveView.Components.Visualisation.md): LiveComponent for 3D robot visualisation using Three.js.
- [BB.LiveView.ConnCase](BB.LiveView.ConnCase.md): Test case for connection-based tests.
- [BB.LiveView.DashboardLive](BB.LiveView.DashboardLive.md): Main LiveView for the BB Dashboard.
- [BB.LiveView.FeatureCase](BB.LiveView.FeatureCase.md): Test case for feature tests using phoenix_test.
- [BB.LiveView.Hooks.AssignRobot](BB.LiveView.Hooks.AssignRobot.md): LiveView on_mount hook that assigns the robot module to the socket.
- [BB.LiveView.Layouts](BB.LiveView.Layouts.md): Layout components for the BB Dashboard.
- [BB.LiveView.Plugs.Static](BB.LiveView.Plugs.Static.md): Serves static assets bundled with the BB LiveView library.
- [BB.LiveView.Router](BB.LiveView.Router.md): Provides router helpers for mounting the BB Dashboard.
- [BB.LiveView.TestEndpoint](BB.LiveView.TestEndpoint.md): Test endpoint for BB Dashboard integration tests.

- [BB.LiveView.TestRobot](BB.LiveView.TestRobot.md): A mock robot module for testing the BB Dashboard.

- [BB.LiveView.TestRouter](BB.LiveView.TestRouter.md): Test router for BB Dashboard integration tests.

- [Dev.TestRobot](Dev.TestRobot.md): A simulated WidowX-200 style robot arm for development and testing.

## Mix Tasks

- [mix bb_liveview.install](Mix.Tasks.BbLiveview.Install.md): Installs BB.LiveView dashboard into a Phoenix project