mirror of
https://github.com/google/bumble.git
synced 2026-04-16 00:25:31 +00:00
wip (+5 squashed commits)
Squashed commits: [53c6c53] wip [66f482c] wip [b003315] wip [f6f9d9e] wip [4c95c7b] wip
This commit is contained in:
@@ -67,9 +67,16 @@ nav:
|
||||
- Zephyr: platforms/zephyr.md
|
||||
- Examples:
|
||||
- Overview: examples/index.md
|
||||
<<<<<<< HEAD
|
||||
- Extras:
|
||||
- Overview: extras/index.md
|
||||
- Android Remote HCI: extras/android_remote_hci.md
|
||||
=======
|
||||
- Hive:
|
||||
- Overview: hive/index.md
|
||||
- Speaker: hive/web/speaker/speaker.html
|
||||
- Scanner: hive/web/scanner/scanner.html
|
||||
>>>>>>> 2e9fb96 (wip (+5 squashed commits))
|
||||
|
||||
copyright: Copyright 2021-2023 Google LLC
|
||||
|
||||
|
||||
29
docs/mkdocs/src/hive/index.md
Normal file
29
docs/mkdocs/src/hive/index.md
Normal file
@@ -0,0 +1,29 @@
|
||||
HIVE
|
||||
====
|
||||
|
||||
Welcome to the Bumble Hive.
|
||||
This is a collection of apps and virtual devices that can run entirely in a browser page.
|
||||
The code for the apps and devices, as well as the Bumble runtime code, runs via [Pyiodide](https://pyodide.org/).
|
||||
Pyodide is a Python distribution for the browser and Node.js based on WebAssembly.
|
||||
|
||||
The Bumble stack uses a WebSocket to exchange HCI packets with a virtual or physical
|
||||
Bluetooth controller.
|
||||
|
||||
The apps and devices in the hive can be accessed by following the links below. Each
|
||||
page has a settings button that may be used to configure the WebSocket URL to use for
|
||||
the virutal HCI connection. This will typically be the WebSocket URL for a `netsim`
|
||||
daemon.
|
||||
There is also a [TOML index](index.toml) that can be used by tools to know at which URL to access
|
||||
each of the apps and devices, as well as their names and short desciptions.
|
||||
|
||||
|
||||
Applications
|
||||
------------
|
||||
|
||||
* [Scanner](web/scanner/scanner.html) - Scans for BLE devices.
|
||||
|
||||
Virtual Devices
|
||||
---------------
|
||||
|
||||
* [Speaker](web/speaker/speaker.html) - Virtual speaker that plays audio in a browser page.
|
||||
|
||||
15
docs/mkdocs/src/hive/index.toml
Normal file
15
docs/mkdocs/src/hive/index.toml
Normal file
@@ -0,0 +1,15 @@
|
||||
version = "1.0.0"
|
||||
base_url = "https://google.github.io/bumble/hive/web"
|
||||
default_hci_query_param = "hci"
|
||||
|
||||
[[index]]
|
||||
name = "speaker"
|
||||
description = "Bumble Virtual Speaker"
|
||||
type = "Device"
|
||||
url = "speaker/speaker.html"
|
||||
|
||||
[[index]]
|
||||
name = "scanner"
|
||||
description = "Simple Scanner Application"
|
||||
type = "Application"
|
||||
url = "scanner/scanner.html"
|
||||
1
docs/mkdocs/src/hive/web/bumble.js
Symbolic link
1
docs/mkdocs/src/hive/web/bumble.js
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../../../web/bumble.js
|
||||
1
docs/mkdocs/src/hive/web/scanner/scanner.html
Symbolic link
1
docs/mkdocs/src/hive/web/scanner/scanner.html
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../../../../web/scanner/scanner.html
|
||||
1
docs/mkdocs/src/hive/web/scanner/scanner.py
Symbolic link
1
docs/mkdocs/src/hive/web/scanner/scanner.py
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../../../../web/scanner/scanner.py
|
||||
1
docs/mkdocs/src/hive/web/speaker/logo.svg
Symbolic link
1
docs/mkdocs/src/hive/web/speaker/logo.svg
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../../../../web/speaker/logo.svg
|
||||
1
docs/mkdocs/src/hive/web/speaker/speaker.css
Symbolic link
1
docs/mkdocs/src/hive/web/speaker/speaker.css
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../../../../web/speaker/speaker.css
|
||||
1
docs/mkdocs/src/hive/web/speaker/speaker.html
Symbolic link
1
docs/mkdocs/src/hive/web/speaker/speaker.html
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../../../../web/speaker/speaker.html
|
||||
1
docs/mkdocs/src/hive/web/speaker/speaker.js
Symbolic link
1
docs/mkdocs/src/hive/web/speaker/speaker.js
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../../../../web/speaker/speaker.js
|
||||
1
docs/mkdocs/src/hive/web/speaker/speaker.py
Symbolic link
1
docs/mkdocs/src/hive/web/speaker/speaker.py
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../../../../web/speaker/speaker.py
|
||||
1
docs/mkdocs/src/hive/web/ui.js
Symbolic link
1
docs/mkdocs/src/hive/web/ui.js
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../../../web/ui.js
|
||||
@@ -14,7 +14,7 @@ connections.
|
||||
|
||||
## Moniker
|
||||
The moniker syntax for an Android Emulator "netsim" transport is: `android-netsim:[<host>:<port>][<options>]`,
|
||||
where `<options>` is a ','-separated list of `<name>=<value>` pairs`.
|
||||
where `<options>` is a comma-separated list of `<name>=<value>` pairs.
|
||||
The `mode` parameter name can specify running as a host or a controller, and `<hostname>:<port>` can specify a host name (or IP address) and TCP port number on which to reach the gRPC server for the emulator (in "host" mode), or to accept gRPC connections (in "controller" mode).
|
||||
Both the `mode=<host|controller>` and `<hostname>:<port>` parameters are optional (so the moniker `android-netsim` by itself is a valid moniker, which will create a transport in `host` mode, connected to `localhost` on the default gRPC port for the Netsim background process).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user