bscontroller 0.1.0__tar.gz

bscontroller-0.1.0/LICENSE

@@ -0,0 +1,221 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+---
+
+
+Files: src/bscontroller/colors.py
+Copyright (c) 2012 Giorgos Verigakis <verigak@gmail.com>
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

bscontroller-0.1.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include LICENSE NOTICE README.md README.zh-CN.md
+recursive-include docs *.svg *.md
+recursive-include src *.py py.typed
+recursive-include tests *.py *.md
+recursive-include examples *.py *.md

bscontroller-0.1.0/NOTICE

@@ -0,0 +1,14 @@
+BSController
+Copyright 2026 Xiaomi Corporation
+
+Protocol codecs and supporting utilities include code:
+Copyright 2021-2025 Google LLC
+
+The source files retain their individual copyright and license notices.
+The package namespace and runtime entry points have been adapted for this
+independent distribution. The LE radio execution path retains adapted HCI codecs and supporting
+utilities; the former LocalLink, BR/EDR/LMP, and pairing execution paths
+have been removed.
+
+The terminal color utility carries the ISC permission notice reproduced in
+LICENSE and src/bscontroller/colors.py.

bscontroller-0.1.0/PKG-INFO

@@ -0,0 +1,260 @@
+Metadata-Version: 2.4
+Name: bscontroller
+Version: 0.1.0
+Summary: Standalone Bluetooth LE controller with discrete simulation time
+License-Expression: Apache-2.0 AND ISC
+Project-URL: Homepage, https://github.com/XiaoMi/bsworld/tree/main/components/bscontroller
+Project-URL: Issues, https://github.com/XiaoMi/bsworld/issues
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: cryptography>=44.0.3
+Provides-Extra: test
+Requires-Dist: pytest>=8.4; extra == "test"
+Requires-Dist: pytest-asyncio>=1.4; extra == "test"
+Requires-Dist: pytest-xdist>=3; extra == "test"
+Requires-Dist: ruff==0.14.10; extra == "test"
+Requires-Dist: build>=1; extra == "test"
+Dynamic: license-file
+
+# BSController
+
+English | [简体中文](README.zh-CN.md)
+
+BSController is a Bluetooth LE Controller written in Python. Your Host stack talks to it over standard H4 HCI, and it transmits and receives over a simulated radio ([BabbleSim](https://babblesim.github.io/)). Controllers on the same simulated radio communicate with each other. Simulation time is discrete, so runs are reproducible.
+
+## Quick start
+
+BSController needs Linux, Python 3.11 or newer, and a BabbleSim build. On Ubuntu 24.04 x86_64, install the build tools:
+
+```sh
+sudo apt-get update
+sudo apt-get install -y git repo build-essential gcc-multilib g++-multilib python3-venv
+```
+
+Fetch BabbleSim and build its PHY, modem and channel models:
+
+```sh
+mkdir -p "$HOME/bsim" && cd "$HOME/bsim"
+repo init -u https://github.com/BabbleSim/manifest.git -m everything.xml -b master
+repo sync
+export BSIM_OUT_PATH="$PWD/build"
+export BSIM_COMPONENTS_PATH="$PWD/components"
+make -j"$(nproc)" ext_2G4_phy_v1 ext_2G4_modem_BLE_simple ext_2G4_channel_multiatt
+```
+
+Keep `BSIM_OUT_PATH` exported whenever you run BSController. See the BabbleSim [fetching](https://babblesim.github.io/fetching.html) and [building](https://babblesim.github.io/building.html) guides for other options.
+
+Then install BSController from this directory:
+
+```sh
+python3 -m venv .venv
+source .venv/bin/activate
+python -m pip install .
+```
+
+## Standalone Controller
+
+Start a Controller and connect your Host to its socket:
+
+```sh
+bscontroller serve --hci-socket /tmp/radio.sock --btsnoop-file /tmp/hci.snoop
+```
+
+`serve` starts a BabbleSim PHY and serves H4 HCI on the Unix socket. It accepts one Host and exits when that Host disconnects; the socket path must not exist. `--btsnoop-file` saves the HCI traffic for Wireshark. See `bscontroller serve --help`.
+
+The Controller runs on simulation time, which advances as fast as the machine allows. A Host that uses wall-clock time sees the Controller run ahead, so timers and timeouts on the two sides disagree.
+
+For reproducible results, the Host must join the same discrete-time schedule. For a quick manual test, add BabbleSim's handbrake device instead, which holds simulation time close to wall-clock time. Start the PHY with one extra device, then join it:
+
+```sh
+cd "$BSIM_OUT_PATH/bin"
+./bs_2G4_phy_v1 -s=demo -D=3 &           # 0: Controller, 1: serve clock, 2: handbrake
+./bs_device_handbrake -s=demo -d=2 -r=1 &  # -r: simulation/wall-clock ratio
+bscontroller serve --join --sim-id demo --dev-id 0 --clock-id 1 \
+  --hci-socket /tmp/radio.sock --btsnoop-file /tmp/hci.snoop
+```
+
+Timing then still depends on host load, so use this only for exploration.
+
+## Using BSController from Python
+
+`RadioController` runs one Controller in its own worker thread. Create it inside a running asyncio event loop. `RadioSession` joins it to a PHY that is already running. The example below expects a PHY started with the same `sim_id` (`example`) and two devices: device `0` for the Controller and device `1` for the Host clock.
+
+```python
+import asyncio
+from pathlib import Path
+
+from bscontroller import RadioController, RadioEventLoop, RadioSession
+
+
+async def main():
+    controller = RadioController(
+        "controller", "F0:F1:F2:F3:F4:01", hci_socket=Path("/tmp/radio.sock")
+    )
+    async with RadioSession("example", [(0, controller)], clock_dev_id=1):
+        await controller.terminated
+
+
+with asyncio.Runner(loop_factory=RadioEventLoop) as runner:
+    runner.run(main())
+```
+
+[examples/advertise_scan.py](examples/advertise_scan.py) is a complete program built on these APIs: it starts the PHY with `PhyProcess`, runs an advertising and a scanning Controller in one `RadioSession`, and a mock Host scans over the scanner's socket. Run it with `python examples/advertise_scan.py`; see [examples/README.md](examples/README.md).
+
+There are two ways to connect a Host:
+
+- **Socket.** Pass `hci_socket`, as above. Any Host that speaks H4 over a Unix socket can connect. Startup returns once the socket is listening. HCI commands are processed after the Controller has synchronized with the PHY.
+- **In process.** Omit `hci_socket`. Register an object with an `on_packet(packet: bytes)` method through `controller.set_packet_sink(sink)` before starting, then send complete H4 packets with `controller.on_packet(packet)`.
+
+Pass `hci_snoop_file=Path(...)` to record a BTSnoop capture, timestamped with simulation time.
+
+Other public names are `ControllerConfig` (see [Configuration](#configuration)), `RadioEventLoop`, `Radio`, `Phy`, `Received` and `hci` (HCI packet classes).
+
+When managing the runtime yourself:
+
+- `RadioSession` does not start the PHY; use `bscontroller.runtime.PhyProcess`.
+- With `clock_dev_id`, the Host event loop must be a `RadioEventLoop`. Without it, you provide the clock and a distinct PHY device ID for every participant.
+- Stop the Controllers before closing the Host clock and the PHY; `async with RadioSession(...)` does this.
+
+## Configuration
+
+Values the Bluetooth specification leaves to the Controller form a `ControllerConfig`. Unset fields keep their defaults.
+
+| JSON key | Default | Range | Spec (Vol 4, Part E) |
+|---|---|---|---|
+| `hciVersion` | `0x0F` (6.1) | `0x06`–`0x10` | 7.4.1 |
+| `hciRevision` | `0` | `0`–`0xFFFF` | 7.4.1 |
+| `lmpVersion` | `0x0F` (6.1) | `0x06`–`0x10` | 7.4.1 |
+| `lmpSubversion` | `0` | `0`–`0xFFFF` | 7.4.1 |
+| `manufacturer` | `0xFFFF` | `0`–`0xFFFF` | 7.4.1 |
+| `aclPacketCount` | `8` | `1`–`255` | 7.8.2 |
+| `aclPacketLength` | `251` | `27`–`65535` | 7.8.2 |
+| `maxTxOctets` | `251` | `27`–`251` | 7.8.46 |
+| `maxTxTime` | `17040` | `328`–`17040` | 7.8.46 |
+| `maxRxOctets` | `251` | `27`–`251` | 7.8.46 |
+| `maxRxTime` | `17040` | `328`–`17040` | 7.8.46 |
+| `advertisingSetCount` | `16` | `1`–`240` | 7.8.58 |
+| `maxAdvertisingDataLength` | `1650` | `31`–`1650` | 7.8.57 |
+| `filterAcceptListSize` | `16` | `1`–`255` | 7.8.14 |
+| `resolvingListSize` | `16` | `1`–`255` | 7.8.41 |
+| `periodicAdvertiserListSize` | `8` | `1`–`255` | 7.8.73 |
+| `maxConnections` | `64` | `1`–`3839` | 5.3.1 |
+| `maxPeriodicSyncs` | `16` | `1`–`3839` | 5.3.1 |
+
+A configuration file has a `defaults` object for every Controller, and a `controllers` object with one entry per Controller name:
+
+```json
+{
+  "defaults": {"aclPacketCount": 16},
+  "controllers": {"hci0": {"maxConnections": 2}, "hci1": {"maxTxOctets": 27}}
+}
+```
+
+Keys are camelCase; snake_case also works. For each value, the most specific source wins: built-in default, then `defaults`, then `controllers.<name>`, then Python keyword arguments. An unknown key, or a value outside its range, is skipped with a warning; that field keeps its previous value and the rest of the file still applies.
+
+On the command line:
+
+```sh
+bscontroller config > bsc.json        # every default, ready to edit
+bscontroller serve --hci-socket /tmp/radio.sock --config bsc.json --name hci0
+```
+
+In Python, pass the file (or an equivalent dict) to `RadioController`. Each Controller picks the `controllers` entry with its own name:
+
+```python
+from bscontroller import ControllerConfig, RadioController
+
+central = RadioController("hci0", "F0:F1:F2:F3:F4:01", config="bsc.json")
+peripheral = RadioController("hci1", "F0:F1:F2:F3:F4:02", config="bsc.json")
+other = RadioController("x", "F0:F1:F2:F3:F4:03", config=ControllerConfig(max_connections=2))
+```
+
+`ControllerConfig(...)` raises `ValueError` for an invalid value.
+
+## Supported features
+
+These are the Link Layer features of the Bluetooth Core specification, listed by the version that introduced them. `*` marks implemented features. Assigned Link Layer feature bits are reported in the LE FeatureSet ([Vol 6, Part B, 4.6](https://www.bluetooth.com/wp-content/uploads/Files/Specification/HTML/Core_v6.3/out/en/low-energy-controller/link-layer-specification.html#UUID-56ada5ed-4ae3-acee-198f-27ead57d86f1)). Bluetooth Classic (BR/EDR) is not.
+
+| Core spec version | Link Layer feature | Supported |
+|---|---|:---:|
+| 4.0 | LE Encryption | * |
+| 4.1 | Connection Parameters Request Procedure | * |
+| 4.1 | Extended Reject Indication | * |
+| 4.1 | Peripheral-initiated Features Exchange | * |
+| 4.1 | LE Ping Procedure | * |
+| 4.2 | LE Data Packet Length Extension | * |
+| 4.2 | LL Privacy | * |
+| 4.2 | Extended Scanner Filter Policies | * |
+| 5.0 | LE 2M PHY | * |
+| 5.0 | LE Coded PHY | * |
+| 5.0 | Channel Selection Algorithm #2 | * |
+| 5.0 | Minimum Number of Used Channels Procedure | * |
+| 5.0 | Extended Advertising | * |
+| 5.0 | Periodic Advertising | * |
+| 5.1 | Connection CTE Request |  |
+| 5.1 | Connection CTE Response |  |
+| 5.1 | Connectionless CTE Transmitter |  |
+| 5.1 | Connectionless CTE Receiver |  |
+| 5.1 | Periodic Advertising Sync Transfer |  |
+| 5.1 | Initiating Periodic Advertising Sync Transfer for Local Periodic Advertising |  |
+| 5.1 | Initiating Periodic Advertising Sync Transfer for Remote Periodic Advertising |  |
+| 5.2 | Isochronous Broadcaster |  |
+| 5.2 | Synchronized Receiver |  |
+| 5.2 | Connected Isochronous Stream (CIS) |  |
+| 5.3 | Periodic Advertising ADI Support |  |
+| 5.3 | LE Channel Classification |  |
+| 5.3 | Connection Subrating |  |
+| 5.4 | Periodic Advertising with Responses |  |
+| 6.0 | Channel Sounding |  |
+| 6.0 | Decision-Based Advertising Filtering | * |
+| 6.0 | Monitoring Advertisers |  |
+| 6.0 | Frame Space Update |  |
+| 6.1 | Randomized RPA Updates | * |
+| 6.2 | Shorter Connection Intervals |  |
+| 6.2 | Channel Sounding Amplitude-based Attack Resilience |  |
+| 6.3 | Channel Sounding Inline Phase Correction Term Transfer |  |
+
+## How it works
+
+Each Controller contains an HCI layer, a Link Layer and a radio adapter. All Controllers connect to one BabbleSim PHY, which carries their packets on shared channels and advances one common simulation clock. Protocol behaviour follows [Bluetooth Core 6.3](https://www.bluetooth.com/wp-content/uploads/Files/Specification/HTML/Core_v6.3/out/en/architecture,-change-history,-and-conventions/architecture.html#UUID-37039e1f-e0cd-37ce-2cf0-15dd6e6cff2e).
+
+<div align="center"><img src="docs/images/radio_controller_arch.svg" alt="Multiple Controllers sharing a BabbleSim PHY" width="80%"><br><em>Figure 1: Controllers on a shared PHY</em></div>
+
+Inside one Controller, the Link Layer keeps a manager for each role (advertising, scanning, initiating, synchronizing, connections). Every ACL connection has its own control-procedure state, encryption state and connection-event executor. All roles share one radio scheduler, which decides what the single radio does next.
+
+![Internal modules, state ownership and interaction paths of one Controller](docs/images/radio_controller_internal_arch.svg)
+
+*Figure 2: Inside one Controller. Nested boxes show ownership. Black arrows are calls, dashed green arrows are callbacks, orange marks scheduling, blue marks PDUs and radio results, and dotted gray marks runtime wiring.*
+
+**Threads and time.** Each `RadioController` runs in a dedicated thread with its own event loop and PHY connection. The Host thread and the Controller thread share no state; they only pass immutable H4 packets. Radio time is in integer microseconds. Every Controller, and an optional Host clock, synchronizes with the PHY before simulation time advances, so timing does not depend on how fast the machine is.
+
+| Object | Owns |
+| --- | --- |
+| `RadioController` | Worker thread, Controller event loop, radio connection |
+| `RadioSession` | Starting and stopping workers, optional Host clock |
+| `H4Server` | Unix socket, the Host connection, H4 framing |
+| `PhyProcess` | BabbleSim PHY process, its logs and simulation directory |
+
+## Development
+
+```text
+.
+├── src/bscontroller/     # Package: HCI, Link Layer, radio, runtime, config
+├── examples/             # Runnable two-Controller example with a mock Host
+└── tests/
+    ├── unit/             # Fast tests, no PHY needed
+    └── qualification/    # HCI/LL protocol cases; radio cases need BabbleSim
+```
+
+```sh
+python -m pip install -e '.[test]'
+python -m pytest tests/unit -n auto -q                  # about 3 s
+python -m pytest tests/qualification -n auto -v -rs     # a few minutes, needs BSIM_OUT_PATH
+python -m build                                         # sdist and wheel in dist/
+```
+
+The qualification suite runs 612 selected HCI and Link Layer test cases from the Bluetooth test specifications against independent lower testers. Passing them does not make BSController Bluetooth-qualified. See [tests/README.md](tests/README.md) for the test scope.
+
+Licensing and third-party notices are in [LICENSE](LICENSE) and [NOTICE](NOTICE).