bsworld 1.1.3__tar.gz

bsworld-1.1.3/.gitignore

@@ -0,0 +1,22 @@
+# Python
+__pycache__/
+*.pyc
+*.egg-info/
+.venv/
+
+# Build and test artifacts
+build/
+dist/
+prebuilt/
+target/
+.cache/
+.pytest_cache/
+.ruff_cache/
+.coverage
+.coverage.*
+
+# Local configuration
+.vscode/
+*.local
+.env
+.env.*

bsworld-1.1.3/.python-version

@@ -0,0 +1 @@
+3.12

bsworld-1.1.3/CODE_OF_CONDUCT.md

@@ -0,0 +1,44 @@
+# Code of Conduct
+
+[English](CODE_OF_CONDUCT.md) | [简体中文](docs/zh-CH/CODE_OF_CONDUCT.md)
+
+## Our Pledge
+
+We pledge to make participation in the BSWorld community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socioeconomic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We will act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Expected Behavior
+
+Examples of behavior that contributes to a positive community include:
+
+- showing empathy, patience, and respect toward other people;
+- respecting differing opinions, experiences, and technical approaches;
+- giving and accepting constructive technical feedback;
+- taking responsibility for mistakes, correcting them, and learning from them;
+- focusing discussion on the project and the needs of the wider community.
+
+Unacceptable behavior includes:
+
+- sexualized language or imagery, or unwelcome sexual attention or advances;
+- trolling, insults, derogatory comments, or personal and political attacks;
+- public or private harassment;
+- publishing another person's private information without explicit permission;
+- threats, intimidation, deliberate disruption, or sustained bad-faith participation;
+- other conduct that would reasonably be considered inappropriate in a professional setting.
+
+## Scope
+
+This Code of Conduct applies to project repositories, issues, pull requests, reviews, discussions, chat channels, events, and other spaces managed by the project. It also applies when someone officially represents BSWorld in a public space.
+
+## Reporting and Enforcement
+
+Report abusive, harassing, or otherwise unacceptable behavior privately by emailing [menglingao@xiaomi.com](mailto:menglingao@xiaomi.com). Do not open a public issue containing personal or sensitive details.
+
+Project maintainers will review reports fairly, protect the privacy and safety of reporters, and take action appropriate to the circumstances. Maintainers may edit or remove comments, commits, code, issues, and other contributions that violate this policy. Depending on the severity and history of the behavior, consequences may include a private correction, formal warning, temporary restriction, or permanent removal from project spaces.
+
+Anyone responsible for handling a report must disclose a conflict of interest and withdraw from that case. Retaliation against a person who reports an incident or participates in an investigation is itself a violation of this Code of Conduct.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). Its Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).

bsworld-1.1.3/CONTRIBUTING.md

@@ -0,0 +1,132 @@
+# Contributing to BSWorld
+
+[English](CONTRIBUTING.md) | [简体中文](docs/zh-CH/CONTRIBUTING.md)
+
+Thank you for contributing to BSWorld. Contributions may include bug fixes, tests, documentation, new Bluetooth LE Application environments, platform integrations, and improvements to the deterministic runtime or RF orchestration.
+
+BSWorld's first-party code is licensed under Apache License 2.0. Imported or reused components retain their original licenses and are identified in their source files and [Third-Party Notices](THIRD_PARTY_NOTICES.md). All commits use the [Developer Certificate of Origin](https://developercertificate.org/) process and record the contributor's certification with a `Signed-off-by` line.
+
+## Before You Start
+
+- Search existing issues before opening a new one.
+- Use [SECURITY.md](SECURITY.md) for vulnerabilities. Do not disclose security-sensitive details in a public issue.
+- Open an issue before starting a substantial architectural change, new backend, or broad API change so the design and scope can be discussed first.
+- Small fixes, focused tests, and documentation corrections may be submitted directly as a pull request.
+- Follow the [Code of Conduct](CODE_OF_CONDUCT.md) in all project spaces.
+
+## Development Setup
+
+We recommend the [Docker test image](docker/README.md#run-tests) with your checkout mounted at `/workspace` for lint, unit tests, and integration tests. To change firmware or build configuration, [build your own image](docker/README.md#build).
+
+## Making Changes
+
+- Keep each change focused on one behavior or problem. Avoid unrelated refactoring and generated-file churn.
+- Follow the existing separation between reusable framework code in `src/bsworld/` and Application-specific profiles, build files, and scenarios under `tests/`.
+- Use standard asyncio APIs for asynchronous test work. Do not use blocking waits such as `time.sleep()` in an async test.
+- Add or update tests for externally visible behavior. Prefer assertions on public outcomes over private implementation details.
+- Update English and Chinese documentation together when behavior, commands, or public interfaces change.
+- Do not commit locally compiled binaries, caches, or test logs.
+- Add the Apache-2.0 copyright header used by neighboring files to new first-party source, configuration, and script files. Preserve upstream license headers in third-party code and update `THIRD_PARTY_NOTICES*` when introducing a new external component.
+
+## Validation
+
+Run the checks relevant to the change in the [Docker environment](docker/README.md#run-tests) with your checkout mounted, or in the local Python environment. At minimum, framework changes should pass:
+
+```sh
+ruff check --no-cache .
+ruff format --check --no-cache .
+pytest tests/unit/
+```
+
+Follow the repository's Python [code style](docs/development.md#code-style). The `Code style` workflow checks all maintained Python code on every push and pull request.
+
+Run the affected virtual-system suite when changing process startup, scheduling, HCI, RF behavior, platform configuration, or test Applications. For example:
+
+```sh
+pytest tests/integration/nuttx/btsak -n auto
+pytest tests/integration/nuttx/nimble -n auto
+pytest tests/integration/zephyr/shell -n auto
+pytest tests/integration/bumble -n auto
+```
+
+Use the full suite when the change crosses subsystem boundaries:
+
+```sh
+pytest tests/ -n auto
+```
+
+If a required suite cannot be run locally, state that explicitly in the pull request and explain why.
+
+## Pull Requests
+
+A pull request should:
+
+- explain the problem and why the change is needed;
+- describe the resulting behavior, including compatibility implications;
+- list the exact validation commands and results;
+- include matching tests and documentation where applicable;
+- identify new dependencies, copied code, generated assets, or license implications;
+- avoid credentials, private logs, machine-specific paths, and unrelated binary files.
+
+Review may request that a large change be split into smaller commits. Commit messages should be concise, use the imperative mood, and describe the externally meaningful change rather than the editing process.
+
+## Developer Certificate of Origin
+
+BSWorld uses the Developer Certificate of Origin 1.1 instead of a separate contributor license agreement. Every commit in a pull request must contain a sign-off line with the contributor's real name and email address:
+
+```text
+Signed-off-by: Jane Doe <jane@example.com>
+```
+
+Add it automatically when creating a commit:
+
+```sh
+git commit --signoff
+```
+
+To sign an existing local commit, amend it before publishing the pull request:
+
+```sh
+git commit --amend --signoff --no-edit
+```
+
+The sign-off certifies your agreement to the following declaration:
+
+```text
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+1 Letterman Drive
+Suite D4700
+San Francisco, CA, 94129
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+```

bsworld-1.1.3/LICENSE

@@ -0,0 +1,201 @@
+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.

bsworld-1.1.3/MANIFEST.in

@@ -0,0 +1,6 @@
+# bscontroller is released as its own package; CI and image files are not
+# part of the bsworld source distribution.
+prune components
+prune docker
+prune .github
+exclude .dockerignore

bsworld-1.1.3/PKG-INFO

@@ -0,0 +1,183 @@
+Metadata-Version: 2.4
+Name: bsworld
+Version: 1.1.3
+Summary: Deterministic simulation test framework for Bluetooth LE Applications
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/XiaoMi/bsworld
+Project-URL: Issues, https://github.com/XiaoMi/bsworld/issues
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytest>=8.4
+Requires-Dist: pytest-asyncio>=1.4
+Requires-Dist: bscontroller<0.2,>=0.1
+Provides-Extra: bumble
+Requires-Dist: bumble==0.0.235; extra == "bumble"
+Provides-Extra: test
+Requires-Dist: bumble==0.0.235; extra == "test"
+Requires-Dist: packaging>=24; extra == "test"
+Requires-Dist: pytest-cov>=4.0; extra == "test"
+Requires-Dist: pytest-xdist>=3.0; extra == "test"
+Requires-Dist: ruff==0.14.10; extra == "test"
+Dynamic: license-file
+
+# BSWorld
+
+[English](README.md) | [简体中文](docs/zh-CH/README.md)
+
+BSWorld is a deterministic simulation framework for testing Bluetooth Hosts and Applications on Linux. A pytest scenario defines the device topology and expected behavior; BSWorld runs the participants on a shared BabbleSim radio and simulation clock, then archives logs and protocol traces.
+
+Use BSWorld to:
+
+- Test open-source Host stacks such as Zephyr, NuttX, BlueZ, NimBLE, Bumble, and TrouBLE without modifying their source code.
+- Run without hardware: Hosts connect over standard H4 HCI to virtual Controllers, or complete firmware joins the PHY with its own Controller and radio.
+- Keep Application logs, HCI BTSnoop captures, PHY logs, and Ellisys traces for debugging failures.
+- Simulate many devices in one scenario. Repeated runs of the same scenario produce consistent logs and timing, regardless of host load or scheduling.
+- Share one discrete simulation clock across all devices. Scenarios are isolated and run in parallel with pytest-xdist, up to 100 times faster than real time.
+- Inject attenuation, interference, WLAN activity, and recorded radio signals.
+
+## Quick Start
+
+BSWorld runs on Linux/x86_64. The published Docker image includes Python, BSWorld, and the firmware required by the integration tests.
+
+### Docker (Recommended)
+
+Install [Docker Engine](https://docs.docker.com/engine/install/ubuntu/), then run the packaged integration tests:
+
+```sh
+sudo docker pull ghcr.io/xiaomi/bsworld:latest
+mkdir -p .cache/docker-results
+# The published image runs as UID/GID 1000.
+sudo chown 1000:1000 .cache/docker-results
+sudo docker run --rm \
+  -e PYTHONPATH=/workspace \
+  --mount "type=bind,src=$PWD/.cache/docker-results,dst=/output" \
+  ghcr.io/xiaomi/bsworld:latest
+```
+
+Results are written to `.cache/docker-results`, including `pytest.xml`, process logs, HCI captures, and RF traces. See the [Docker guide](docker/README.md) to run a selected suite, test the current checkout, choose an image version, or build an image.
+
+### Local Linux
+
+Development and test commands require Python 3.12 or newer. On Ubuntu 24.04, install the required tools:
+
+```sh
+sudo apt-get update
+sudo apt-get install -y \
+  bash ca-certificates curl git repo file make binutils build-essential \
+  python3.12 python3.12-dev python3.12-venv python3-pip \
+  gcc-multilib g++-multilib coreutils findutils grep sed
+```
+
+Install BSWorld from PyPI. Add the `bumble` extra to run Bumble Hosts in tests:
+
+```sh
+python3.12 -m pip install bsworld            # or 'bsworld[bumble]'
+```
+
+To develop BSWorld, clone it and install BSWorld and the bscontroller in the
+repository from source:
+
+```sh
+git clone https://github.com/XiaoMi/bsworld.git
+cd bsworld
+export BSWORLD_ROOT="$PWD"
+python3.12 -m venv .venv
+source .venv/bin/activate
+python -m pip install -e components/bscontroller -e '.[test]'
+```
+
+Run the development checks:
+
+```sh
+ruff check src tests
+pytest tests/unit -q
+```
+
+#### Build and Test
+
+Fetch the BabbleSim revisions selected by `components/babblesim.xml`:
+
+```sh
+mkdir -p "$BSWORLD_ROOT/.cache/babblesim"
+cd "$BSWORLD_ROOT/.cache/babblesim"
+repo init --standalone-manifest --depth=1 -u "file://$BSWORLD_ROOT/components/babblesim.xml"
+repo sync -c --no-tags
+```
+
+Set the output paths and build every component:
+
+```sh
+export BSIM_OUT_PATH="$PWD/build"
+export BSIM_COMPONENTS_PATH="$PWD/components"
+export BSIM_BUILD_FAIL_ASAP=1
+make -j"$(nproc)" everything
+```
+
+Run the Bumble scenarios on BSController, which need no other binaries:
+
+```sh
+cd "$BSWORLD_ROOT"
+pytest tests/integration/bumble -n auto -k '[bscontroller]'
+```
+
+### Test Controller Variants
+
+Integration scenarios run with both the Zephyr Controller (`[zephyr]`) and Python BSController (`[bscontroller]`); `[zephyr]` cases are skipped when the Zephyr Controller is not built. See [Virtual Controllers](docs/controllers.md).
+
+Select one implementation with its pytest parameter ID:
+
+```sh
+pytest tests/integration -n auto -v -k '[zephyr]'
+pytest tests/integration -n auto -v -k '[bscontroller]'
+```
+
+## Supported Integrations
+
+| Environment | Validated behavior | Guide |
+|---|---|---|
+| Zephyr Bluetooth shell | Advertising and scanning, interference and recovery, connections and GATT, LL procedures, pairing and privacy, periodic advertising; complete firmware against Host-only shells on either Controller and against Bumble | [Zephyr tests](tests/integration/zephyr/README.md) |
+| Bumble Python Host | Advertising, scanning, connections, periodic advertising and synchronization | [Bumble tests](tests/integration/bumble/README.md) |
+| Linux and BlueZ under QEMU | Controller setup, advertising, scanning, connection and disconnection through the Linux Bluetooth subsystem | [BlueZ tests](tests/integration/qemu/bluez/README.md) |
+| TrouBLE Rust Host | Advertising, connection, Battery Service discovery, reads and notifications | [TrouBLE tests](tests/integration/trouble/README.md) |
+| NuttX BTSak | Advertising, scanning, multiple advertisers, interference and recovery | [BTSak tests](tests/integration/nuttx/btsak/README.md) |
+| Apache NimBLE | Discovery, connection, GATT and subscription on NuttX; discovery and connection under QEMU | [NuttX tests](tests/integration/nuttx/nimble/README.md) · [QEMU tests](tests/integration/qemu/nimble/README.md) |
+
+## Technical Architecture
+
+BSWorld keeps each Application and Host stack on its native interface. Every Host connects through standard HCI to an independent Zephyr Controller process or Python BSController worker. Complete Zephyr firmware includes its own Controller and radio and joins the PHY directly; see [Complete firmware](docs/writing-tests.md#complete-firmware). All Controllers, complete firmware and interference sources share the BabbleSim PHY and simulation clock.
+
+<div align="center"><img src="docs/images/babblesim_arch.svg" alt="BSWorld participants connected through independent virtual Controllers or as complete firmware to a shared BabbleSim PHY" width="80%"><br><em>Figure 1: BSWorld architecture</em><br><br></div>
+
+The virtual Controllers implement HCI commands, events, ACL data, Link Layer procedures, and radio transmission and reception. A topology can mix RTOS, Python, QEMU-based Linux and complete Zephyr participants with either Controller implementation. See [Virtual Controllers](docs/controllers.md) to choose and configure them.
+
+HCI traffic is saved as `hciN.snoop` for Wireshark or another BTSnoop-capable tool. Radio traffic is saved as `babblesim/ellisys.bttrp` for Ellisys. See [Logs, traces, and captures](docs/artifacts.md) for locations and a recommended investigation order.
+
+### Discrete-Time Scheduling
+
+| Time base | Meaning |
+|---|---|
+| **Simulation time** | Defines protocol timers, packet timing, RF events, asyncio waits, and test timeouts. It advances only after all participants synchronize. |
+| **Wall-clock time** | Measures how long the test takes on the host. CPU load and Linux scheduling affect this duration but not protocol timing. |
+
+BSWorld registers Applications, Controllers, interference devices, and pytest in the same simulation. A shared synchronization barrier keeps them on one timeline, so a protocol interval such as `T_IFS = 150 μs` remains 150 μs regardless of host load. After topology startup, standard `asyncio` waits and timeouts use simulation time; see [Async waiting and simulation time](docs/writing-tests.md#async-waiting-and-simulation-time).
+
+Repeatability assumes identical binaries and inputs and controlled random sources. External networks, wall-clock-driven services, and other unadapted Host I/O can still introduce nondeterminism.
+
+## Documentation
+
+- [Writing tests and RF scenarios](docs/writing-tests.md): define topologies, integrate Applications, wait with asyncio, and configure RF conditions.
+- [Virtual Controllers](docs/controllers.md): choose between the Zephyr and Python Controllers, run a scenario against both, and configure BSController.
+- [Logs, traces, and captures](docs/artifacts.md): locate and analyze test artifacts.
+- [Development checks](docs/development.md): run unit tests, lint, and coverage.
+- [Docker guide](docker/README.md): run published images, select suites, and build local images.
+
+## Community
+
+- [Contributing](CONTRIBUTING.md)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [Security Policy](SECURITY.md)
+
+## License
+
+BSWorld is licensed under the [Apache License 2.0](LICENSE). Third-party components retain their own licenses; see [Third-Party Notices](THIRD_PARTY_NOTICES.md).