forked from auracaster/bumble_mirror
Gilles Boccon-Gibod
2958 lines
103 KiB
HTML
2958 lines
103 KiB
HTML
|
|
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
|
|
|
|
|
|
<link rel="prev" href="examples.html">
|
|
|
|
|
|
<link rel="next" href="../apps_and_tools/index.html">
|
|
|
|
|
|
<link rel="icon" href="../images/favicon.ico">
|
|
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.5">
|
|
|
|
|
|
|
|
<title>Reference - Bumble</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/stylesheets/main.6a10b989.min.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
|
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/_mkdocstrings.css">
|
|
|
|
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
<body dir="ltr">
|
|
|
|
|
|
|
|
<script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
|
|
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
<label class="md-overlay" for="__drawer"></label>
|
|
<div data-md-component="skip">
|
|
|
|
|
|
<a href="#bumble-python-api" class="md-skip">
|
|
Skip to content
|
|
</a>
|
|
|
|
</div>
|
|
<div data-md-component="announce">
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<header class="md-header md-header--shadow" data-md-component="header">
|
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
|
<a href="../index.html" title="Bumble" class="md-header__button md-logo" aria-label="Bumble" data-md-component="logo">
|
|
|
|
<img src="../images/logo.png" alt="logo">
|
|
|
|
</a>
|
|
<label class="md-header__button md-icon" for="__drawer">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
|
|
</label>
|
|
<div class="md-header__title" data-md-component="header-title">
|
|
<div class="md-header__ellipsis">
|
|
<div class="md-header__topic">
|
|
<span class="md-ellipsis">
|
|
Bumble
|
|
</span>
|
|
</div>
|
|
<div class="md-header__topic" data-md-component="header-topic">
|
|
<span class="md-ellipsis">
|
|
|
|
Reference
|
|
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="md-header__source">
|
|
<a href="https://github.com/google/bumble" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
GitHub
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
</header>
|
|
|
|
<div class="md-container" data-md-component="container">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<main class="md-main" data-md-component="main">
|
|
<div class="md-main__inner md-grid">
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
|
<label class="md-nav__title" for="__drawer">
|
|
<a href="../index.html" title="Bumble" class="md-nav__button md-logo" aria-label="Bumble" data-md-component="logo">
|
|
|
|
<img src="../images/logo.png" alt="logo">
|
|
|
|
</a>
|
|
Bumble
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
<a href="https://github.com/google/bumble" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
GitHub
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../index.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Introduction
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../getting_started.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Getting Started
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Development
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Development
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../development/python_environments.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Python Environments
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../development/contributing.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Contributing
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../development/code_style.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Code Style
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Use Cases
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Use Cases
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../use_cases/index.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../use_cases/use_case_1.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Use Case 1
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../use_cases/use_case_2.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Use Case 2
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../use_cases/use_case_3.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Use Case 3
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../use_cases/use_case_4.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Use Case 4
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../use_cases/use_case_5.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Use Case 5
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../use_cases/use_case_6.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Use Case 6
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Components
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_5">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Components
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../components/controller.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Controller
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../components/host.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Host
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../components/gatt.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
GATT
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../components/security_manager.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Security Manager
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Transports
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_6">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Transports
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../transports/index.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../transports/serial.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Serial
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../transports/usb.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
USB
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../transports/pty.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
PTY
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../transports/udp.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
UDP
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../transports/tcp_client.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
TCP Client
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../transports/tcp_server.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
TCP Server
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../transports/ws_client.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
WebSocket Client
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../transports/ws_server.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
WebSocket Server
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../transports/vhci.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
VHCI
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../transports/hci_socket.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
HCI Socket
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../transports/android_emulator.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Android Emulator
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../transports/file.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
File
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Drivers
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_7">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Drivers
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../drivers/index.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../drivers/realtek.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Realtek
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" checked>
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
API
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="true">
|
|
<label class="md-nav__title" for="__nav_8">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
API
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="guide.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Guide
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="examples.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Examples
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active">
|
|
|
|
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
|
|
|
|
|
|
|
|
|
|
|
<a href="reference.html" class="md-nav__link md-nav__link--active">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Reference
|
|
</span>
|
|
|
|
|
|
</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Apps & Tools
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_9">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Apps & Tools
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../apps_and_tools/index.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../apps_and_tools/console.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Console
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../apps_and_tools/bench.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Bench
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../apps_and_tools/speaker.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Speaker
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../apps_and_tools/hci_bridge.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
HCI Bridge
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../apps_and_tools/gg_bridge.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Golden Gate Bridge
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../apps_and_tools/show.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Show
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../apps_and_tools/gatt_dump.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
GATT Dump
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../apps_and_tools/pair.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Pair
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../apps_and_tools/unbond.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Unbond
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../apps_and_tools/usb_probe.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
USB Probe
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../apps_and_tools/link_relay.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Link Relay
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Hardware
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_10">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Hardware
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../hardware/index.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_11" id="__nav_11_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Platforms
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_11">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Platforms
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../platforms/index.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../platforms/macos.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
macOS
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../platforms/linux.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Linux
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../platforms/windows.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Windows
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../platforms/android.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Android
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../platforms/zephyr.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Zephyr
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_12" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_12" id="__nav_12_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Examples
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_12_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_12">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Examples
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../examples/index.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_13" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_13" id="__nav_13_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Extras
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_13_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_13">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Extras
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../extras/index.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../extras/android_remote_hci.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Android Remote HCI
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_14" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_14" id="__nav_14_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Hive
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_14_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_14">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Hive
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../hive/index.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../hive/web/speaker/speaker.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Speaker
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../hive/web/scanner/scanner.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Scanner
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../hive/web/heart_rate_monitor/heart_rate_monitor.html" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Heart Rate Monitor
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
|
|
|
|
<h1 id="bumble-python-api">Bumble Python API<a class="headerlink" href="#bumble-python-api" title="Permanent link">¶</a></h1>
|
|
<h1 id="classes">Classes<a class="headerlink" href="#classes" title="Permanent link">¶</a></h1>
|
|
<h2 id="address">Address<a class="headerlink" href="#address" title="Permanent link">¶</a></h2>
|
|
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<a id="bumble.hci.Address"></a>
|
|
<div class="doc doc-contents first">
|
|
|
|
|
|
<p>Bluetooth Address (see Bluetooth spec Vol 6, Part B - 1.3 DEVICE ADDRESS)
|
|
NOTE: the address bytes are stored in little-endian byte order here, so
|
|
address[0] is the LSB of the address, address[5] is the MSB.</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>bumble/hci.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1739</span>
|
|
<span class="normal">1740</span>
|
|
<span class="normal">1741</span>
|
|
<span class="normal">1742</span>
|
|
<span class="normal">1743</span>
|
|
<span class="normal">1744</span>
|
|
<span class="normal">1745</span>
|
|
<span class="normal">1746</span>
|
|
<span class="normal">1747</span>
|
|
<span class="normal">1748</span>
|
|
<span class="normal">1749</span>
|
|
<span class="normal">1750</span>
|
|
<span class="normal">1751</span>
|
|
<span class="normal">1752</span>
|
|
<span class="normal">1753</span>
|
|
<span class="normal">1754</span>
|
|
<span class="normal">1755</span>
|
|
<span class="normal">1756</span>
|
|
<span class="normal">1757</span>
|
|
<span class="normal">1758</span>
|
|
<span class="normal">1759</span>
|
|
<span class="normal">1760</span>
|
|
<span class="normal">1761</span>
|
|
<span class="normal">1762</span>
|
|
<span class="normal">1763</span>
|
|
<span class="normal">1764</span>
|
|
<span class="normal">1765</span>
|
|
<span class="normal">1766</span>
|
|
<span class="normal">1767</span>
|
|
<span class="normal">1768</span>
|
|
<span class="normal">1769</span>
|
|
<span class="normal">1770</span>
|
|
<span class="normal">1771</span>
|
|
<span class="normal">1772</span>
|
|
<span class="normal">1773</span>
|
|
<span class="normal">1774</span>
|
|
<span class="normal">1775</span>
|
|
<span class="normal">1776</span>
|
|
<span class="normal">1777</span>
|
|
<span class="normal">1778</span>
|
|
<span class="normal">1779</span>
|
|
<span class="normal">1780</span>
|
|
<span class="normal">1781</span>
|
|
<span class="normal">1782</span>
|
|
<span class="normal">1783</span>
|
|
<span class="normal">1784</span>
|
|
<span class="normal">1785</span>
|
|
<span class="normal">1786</span>
|
|
<span class="normal">1787</span>
|
|
<span class="normal">1788</span>
|
|
<span class="normal">1789</span>
|
|
<span class="normal">1790</span>
|
|
<span class="normal">1791</span>
|
|
<span class="normal">1792</span>
|
|
<span class="normal">1793</span>
|
|
<span class="normal">1794</span>
|
|
<span class="normal">1795</span>
|
|
<span class="normal">1796</span>
|
|
<span class="normal">1797</span>
|
|
<span class="normal">1798</span>
|
|
<span class="normal">1799</span>
|
|
<span class="normal">1800</span>
|
|
<span class="normal">1801</span>
|
|
<span class="normal">1802</span>
|
|
<span class="normal">1803</span>
|
|
<span class="normal">1804</span>
|
|
<span class="normal">1805</span>
|
|
<span class="normal">1806</span>
|
|
<span class="normal">1807</span>
|
|
<span class="normal">1808</span>
|
|
<span class="normal">1809</span>
|
|
<span class="normal">1810</span>
|
|
<span class="normal">1811</span>
|
|
<span class="normal">1812</span>
|
|
<span class="normal">1813</span>
|
|
<span class="normal">1814</span>
|
|
<span class="normal">1815</span>
|
|
<span class="normal">1816</span>
|
|
<span class="normal">1817</span>
|
|
<span class="normal">1818</span>
|
|
<span class="normal">1819</span>
|
|
<span class="normal">1820</span>
|
|
<span class="normal">1821</span>
|
|
<span class="normal">1822</span>
|
|
<span class="normal">1823</span>
|
|
<span class="normal">1824</span>
|
|
<span class="normal">1825</span>
|
|
<span class="normal">1826</span>
|
|
<span class="normal">1827</span>
|
|
<span class="normal">1828</span>
|
|
<span class="normal">1829</span>
|
|
<span class="normal">1830</span>
|
|
<span class="normal">1831</span>
|
|
<span class="normal">1832</span>
|
|
<span class="normal">1833</span>
|
|
<span class="normal">1834</span>
|
|
<span class="normal">1835</span>
|
|
<span class="normal">1836</span>
|
|
<span class="normal">1837</span>
|
|
<span class="normal">1838</span>
|
|
<span class="normal">1839</span>
|
|
<span class="normal">1840</span>
|
|
<span class="normal">1841</span>
|
|
<span class="normal">1842</span>
|
|
<span class="normal">1843</span>
|
|
<span class="normal">1844</span>
|
|
<span class="normal">1845</span>
|
|
<span class="normal">1846</span>
|
|
<span class="normal">1847</span>
|
|
<span class="normal">1848</span>
|
|
<span class="normal">1849</span>
|
|
<span class="normal">1850</span>
|
|
<span class="normal">1851</span>
|
|
<span class="normal">1852</span>
|
|
<span class="normal">1853</span>
|
|
<span class="normal">1854</span>
|
|
<span class="normal">1855</span>
|
|
<span class="normal">1856</span>
|
|
<span class="normal">1857</span>
|
|
<span class="normal">1858</span>
|
|
<span class="normal">1859</span>
|
|
<span class="normal">1860</span>
|
|
<span class="normal">1861</span>
|
|
<span class="normal">1862</span>
|
|
<span class="normal">1863</span>
|
|
<span class="normal">1864</span>
|
|
<span class="normal">1865</span>
|
|
<span class="normal">1866</span>
|
|
<span class="normal">1867</span>
|
|
<span class="normal">1868</span>
|
|
<span class="normal">1869</span>
|
|
<span class="normal">1870</span>
|
|
<span class="normal">1871</span>
|
|
<span class="normal">1872</span>
|
|
<span class="normal">1873</span>
|
|
<span class="normal">1874</span>
|
|
<span class="normal">1875</span>
|
|
<span class="normal">1876</span>
|
|
<span class="normal">1877</span>
|
|
<span class="normal">1878</span>
|
|
<span class="normal">1879</span>
|
|
<span class="normal">1880</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">Address</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> Bluetooth Address (see Bluetooth spec Vol 6, Part B - 1.3 DEVICE ADDRESS)</span>
|
|
<span class="sd"> NOTE: the address bytes are stored in little-endian byte order here, so</span>
|
|
<span class="sd"> address[0] is the LSB of the address, address[5] is the MSB.</span>
|
|
<span class="sd"> '''</span>
|
|
|
|
<span class="n">PUBLIC_DEVICE_ADDRESS</span> <span class="o">=</span> <span class="mh">0x00</span>
|
|
<span class="n">RANDOM_DEVICE_ADDRESS</span> <span class="o">=</span> <span class="mh">0x01</span>
|
|
<span class="n">PUBLIC_IDENTITY_ADDRESS</span> <span class="o">=</span> <span class="mh">0x02</span>
|
|
<span class="n">RANDOM_IDENTITY_ADDRESS</span> <span class="o">=</span> <span class="mh">0x03</span>
|
|
|
|
<span class="n">ADDRESS_TYPE_NAMES</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="n">PUBLIC_DEVICE_ADDRESS</span><span class="p">:</span> <span class="s1">'PUBLIC_DEVICE_ADDRESS'</span><span class="p">,</span>
|
|
<span class="n">RANDOM_DEVICE_ADDRESS</span><span class="p">:</span> <span class="s1">'RANDOM_DEVICE_ADDRESS'</span><span class="p">,</span>
|
|
<span class="n">PUBLIC_IDENTITY_ADDRESS</span><span class="p">:</span> <span class="s1">'PUBLIC_IDENTITY_ADDRESS'</span><span class="p">,</span>
|
|
<span class="n">RANDOM_IDENTITY_ADDRESS</span><span class="p">:</span> <span class="s1">'RANDOM_IDENTITY_ADDRESS'</span><span class="p">,</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="c1"># Type declarations</span>
|
|
<span class="n">NIL</span><span class="p">:</span> <span class="n">Address</span>
|
|
<span class="n">ANY</span><span class="p">:</span> <span class="n">Address</span>
|
|
<span class="n">ANY_RANDOM</span><span class="p">:</span> <span class="n">Address</span>
|
|
|
|
<span class="c1"># pylint: disable-next=unnecessary-lambda</span>
|
|
<span class="n">ADDRESS_TYPE_SPEC</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'size'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">'mapper'</span><span class="p">:</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">Address</span><span class="o">.</span><span class="n">address_type_name</span><span class="p">(</span><span class="n">x</span><span class="p">)}</span>
|
|
|
|
<span class="nd">@staticmethod</span>
|
|
<span class="k">def</span> <span class="nf">address_type_name</span><span class="p">(</span><span class="n">address_type</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">name_or_number</span><span class="p">(</span><span class="n">Address</span><span class="o">.</span><span class="n">ADDRESS_TYPE_NAMES</span><span class="p">,</span> <span class="n">address_type</span><span class="p">)</span>
|
|
|
|
<span class="nd">@staticmethod</span>
|
|
<span class="k">def</span> <span class="nf">from_string_for_transport</span><span class="p">(</span><span class="n">string</span><span class="p">,</span> <span class="n">transport</span><span class="p">):</span>
|
|
<span class="k">if</span> <span class="n">transport</span> <span class="o">==</span> <span class="n">BT_BR_EDR_TRANSPORT</span><span class="p">:</span>
|
|
<span class="n">address_type</span> <span class="o">=</span> <span class="n">Address</span><span class="o">.</span><span class="n">PUBLIC_DEVICE_ADDRESS</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">address_type</span> <span class="o">=</span> <span class="n">Address</span><span class="o">.</span><span class="n">RANDOM_DEVICE_ADDRESS</span>
|
|
<span class="k">return</span> <span class="n">Address</span><span class="p">(</span><span class="n">string</span><span class="p">,</span> <span class="n">address_type</span><span class="p">)</span>
|
|
|
|
<span class="nd">@staticmethod</span>
|
|
<span class="k">def</span> <span class="nf">parse_address</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">offset</span><span class="p">):</span>
|
|
<span class="c1"># Fix the type to a default value. This is used for parsing type-less Classic</span>
|
|
<span class="c1"># addresses</span>
|
|
<span class="k">return</span> <span class="n">Address</span><span class="o">.</span><span class="n">parse_address_with_type</span><span class="p">(</span>
|
|
<span class="n">data</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">Address</span><span class="o">.</span><span class="n">PUBLIC_DEVICE_ADDRESS</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="nd">@staticmethod</span>
|
|
<span class="k">def</span> <span class="nf">parse_address_with_type</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">address_type</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">offset</span> <span class="o">+</span> <span class="mi">6</span><span class="p">,</span> <span class="n">Address</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="n">offset</span> <span class="p">:</span> <span class="n">offset</span> <span class="o">+</span> <span class="mi">6</span><span class="p">],</span> <span class="n">address_type</span><span class="p">)</span>
|
|
|
|
<span class="nd">@staticmethod</span>
|
|
<span class="k">def</span> <span class="nf">parse_address_preceded_by_type</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">offset</span><span class="p">):</span>
|
|
<span class="n">address_type</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="n">offset</span> <span class="o">-</span> <span class="mi">1</span><span class="p">]</span>
|
|
<span class="k">return</span> <span class="n">Address</span><span class="o">.</span><span class="n">parse_address_with_type</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">address_type</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span> <span class="n">address_type</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">RANDOM_DEVICE_ADDRESS</span>
|
|
<span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> Initialize an instance. `address` may be a byte array in little-endian</span>
|
|
<span class="sd"> format, or a hex string in big-endian format (with optional ':'</span>
|
|
<span class="sd"> separators between the bytes).</span>
|
|
<span class="sd"> If the address is a string suffixed with '/P', `address_type` is ignored and</span>
|
|
<span class="sd"> the type is set to PUBLIC_DEVICE_ADDRESS.</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">address</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">address_bytes</span> <span class="o">=</span> <span class="n">address</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="c1"># Check if there's a '/P' type specifier</span>
|
|
<span class="k">if</span> <span class="n">address</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'P'</span><span class="p">):</span>
|
|
<span class="n">address_type</span> <span class="o">=</span> <span class="n">Address</span><span class="o">.</span><span class="n">PUBLIC_DEVICE_ADDRESS</span>
|
|
<span class="n">address</span> <span class="o">=</span> <span class="n">address</span><span class="p">[:</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span>
|
|
|
|
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">address</span><span class="p">)</span> <span class="o">==</span> <span class="mi">12</span> <span class="o">+</span> <span class="mi">5</span><span class="p">:</span>
|
|
<span class="c1"># Form with ':' separators</span>
|
|
<span class="n">address</span> <span class="o">=</span> <span class="n">address</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">':'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">address_bytes</span> <span class="o">=</span> <span class="nb">bytes</span><span class="p">(</span><span class="nb">reversed</span><span class="p">(</span><span class="nb">bytes</span><span class="o">.</span><span class="n">fromhex</span><span class="p">(</span><span class="n">address</span><span class="p">)))</span>
|
|
|
|
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">address_bytes</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">6</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'invalid address length'</span><span class="p">)</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">address_type</span> <span class="o">=</span> <span class="n">address_type</span>
|
|
|
|
<span class="k">def</span> <span class="nf">clone</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">Address</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">address_bytes</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">address_type</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">is_public</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">address_type</span> <span class="ow">in</span> <span class="p">(</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">PUBLIC_DEVICE_ADDRESS</span><span class="p">,</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">PUBLIC_IDENTITY_ADDRESS</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">is_random</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_public</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">is_resolved</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">address_type</span> <span class="ow">in</span> <span class="p">(</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">PUBLIC_IDENTITY_ADDRESS</span><span class="p">,</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">RANDOM_IDENTITY_ADDRESS</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">is_resolvable</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">address_type</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">RANDOM_DEVICE_ADDRESS</span> <span class="ow">and</span> <span class="p">(</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">address_bytes</span><span class="p">[</span><span class="mi">5</span><span class="p">]</span> <span class="o">>></span> <span class="mi">6</span> <span class="o">==</span> <span class="mi">1</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">is_static</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_random</span> <span class="ow">and</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">address_bytes</span><span class="p">[</span><span class="mi">5</span><span class="p">]</span> <span class="o">>></span> <span class="mi">6</span> <span class="o">==</span> <span class="mi">3</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">to_bytes</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">address_bytes</span>
|
|
|
|
<span class="k">def</span> <span class="nf">to_string</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">with_type_qualifier</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> String representation of the address, MSB first, with an optional type</span>
|
|
<span class="sd"> qualifier.</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="s1">':'</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="sa">f</span><span class="s1">'</span><span class="si">{</span><span class="n">x</span><span class="si">:</span><span class="s1">02X</span><span class="si">}</span><span class="s1">'</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="nb">reversed</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">address_bytes</span><span class="p">)])</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">with_type_qualifier</span> <span class="ow">or</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_public</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">result</span>
|
|
<span class="k">return</span> <span class="n">result</span> <span class="o">+</span> <span class="s1">'/P'</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__bytes__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">to_bytes</span><span class="p">()</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">address_bytes</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="p">(</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">address_bytes</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">address_bytes</span>
|
|
<span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_public</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">is_public</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">to_string</span><span class="p">()</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
|
|
<h2 id="bumble.hci.Address.__init__" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="fm">__init__</span><span class="p">(</span><span class="n">address</span><span class="p">,</span> <span class="n">address_type</span><span class="o">=</span><span class="n">RANDOM_DEVICE_ADDRESS</span><span class="p">)</span></code>
|
|
|
|
<a href="#bumble.hci.Address.__init__" class="headerlink" title="Permanent link">¶</a></h2>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Initialize an instance. <code>address</code> may be a byte array in little-endian
|
|
format, or a hex string in big-endian format (with optional ':'
|
|
separators between the bytes).
|
|
If the address is a string suffixed with '/P', <code>address_type</code> is ignored and
|
|
the type is set to PUBLIC_DEVICE_ADDRESS.</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>bumble/hci.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1795</span>
|
|
<span class="normal">1796</span>
|
|
<span class="normal">1797</span>
|
|
<span class="normal">1798</span>
|
|
<span class="normal">1799</span>
|
|
<span class="normal">1800</span>
|
|
<span class="normal">1801</span>
|
|
<span class="normal">1802</span>
|
|
<span class="normal">1803</span>
|
|
<span class="normal">1804</span>
|
|
<span class="normal">1805</span>
|
|
<span class="normal">1806</span>
|
|
<span class="normal">1807</span>
|
|
<span class="normal">1808</span>
|
|
<span class="normal">1809</span>
|
|
<span class="normal">1810</span>
|
|
<span class="normal">1811</span>
|
|
<span class="normal">1812</span>
|
|
<span class="normal">1813</span>
|
|
<span class="normal">1814</span>
|
|
<span class="normal">1815</span>
|
|
<span class="normal">1816</span>
|
|
<span class="normal">1817</span>
|
|
<span class="normal">1818</span>
|
|
<span class="normal">1819</span>
|
|
<span class="normal">1820</span>
|
|
<span class="normal">1821</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span> <span class="n">address_type</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">RANDOM_DEVICE_ADDRESS</span>
|
|
<span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> Initialize an instance. `address` may be a byte array in little-endian</span>
|
|
<span class="sd"> format, or a hex string in big-endian format (with optional ':'</span>
|
|
<span class="sd"> separators between the bytes).</span>
|
|
<span class="sd"> If the address is a string suffixed with '/P', `address_type` is ignored and</span>
|
|
<span class="sd"> the type is set to PUBLIC_DEVICE_ADDRESS.</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">address</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">address_bytes</span> <span class="o">=</span> <span class="n">address</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="c1"># Check if there's a '/P' type specifier</span>
|
|
<span class="k">if</span> <span class="n">address</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'P'</span><span class="p">):</span>
|
|
<span class="n">address_type</span> <span class="o">=</span> <span class="n">Address</span><span class="o">.</span><span class="n">PUBLIC_DEVICE_ADDRESS</span>
|
|
<span class="n">address</span> <span class="o">=</span> <span class="n">address</span><span class="p">[:</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span>
|
|
|
|
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">address</span><span class="p">)</span> <span class="o">==</span> <span class="mi">12</span> <span class="o">+</span> <span class="mi">5</span><span class="p">:</span>
|
|
<span class="c1"># Form with ':' separators</span>
|
|
<span class="n">address</span> <span class="o">=</span> <span class="n">address</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">':'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">address_bytes</span> <span class="o">=</span> <span class="nb">bytes</span><span class="p">(</span><span class="nb">reversed</span><span class="p">(</span><span class="nb">bytes</span><span class="o">.</span><span class="n">fromhex</span><span class="p">(</span><span class="n">address</span><span class="p">)))</span>
|
|
|
|
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">address_bytes</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">6</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'invalid address length'</span><span class="p">)</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">address_type</span> <span class="o">=</span> <span class="n">address_type</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
|
|
<h2 id="bumble.hci.Address.to_string" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">to_string</span><span class="p">(</span><span class="n">with_type_qualifier</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></code>
|
|
|
|
<a href="#bumble.hci.Address.to_string" class="headerlink" title="Permanent link">¶</a></h2>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>String representation of the address, MSB first, with an optional type
|
|
qualifier.</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>bumble/hci.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1857</span>
|
|
<span class="normal">1858</span>
|
|
<span class="normal">1859</span>
|
|
<span class="normal">1860</span>
|
|
<span class="normal">1861</span>
|
|
<span class="normal">1862</span>
|
|
<span class="normal">1863</span>
|
|
<span class="normal">1864</span>
|
|
<span class="normal">1865</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">to_string</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">with_type_qualifier</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> String representation of the address, MSB first, with an optional type</span>
|
|
<span class="sd"> qualifier.</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="s1">':'</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="sa">f</span><span class="s1">'</span><span class="si">{</span><span class="n">x</span><span class="si">:</span><span class="s1">02X</span><span class="si">}</span><span class="s1">'</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="nb">reversed</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">address_bytes</span><span class="p">)])</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">with_type_qualifier</span> <span class="ow">or</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_public</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">result</span>
|
|
<span class="k">return</span> <span class="n">result</span> <span class="o">+</span> <span class="s1">'/P'</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div><h2 id="hci_packet">HCI_Packet<a class="headerlink" href="#hci_packet" title="Permanent link">¶</a></h2>
|
|
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<a id="bumble.hci.HCI_Packet"></a>
|
|
<div class="doc doc-contents first">
|
|
|
|
|
|
<p>Abstract Base class for HCI packets</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>bumble/hci.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1911</span>
|
|
<span class="normal">1912</span>
|
|
<span class="normal">1913</span>
|
|
<span class="normal">1914</span>
|
|
<span class="normal">1915</span>
|
|
<span class="normal">1916</span>
|
|
<span class="normal">1917</span>
|
|
<span class="normal">1918</span>
|
|
<span class="normal">1919</span>
|
|
<span class="normal">1920</span>
|
|
<span class="normal">1921</span>
|
|
<span class="normal">1922</span>
|
|
<span class="normal">1923</span>
|
|
<span class="normal">1924</span>
|
|
<span class="normal">1925</span>
|
|
<span class="normal">1926</span>
|
|
<span class="normal">1927</span>
|
|
<span class="normal">1928</span>
|
|
<span class="normal">1929</span>
|
|
<span class="normal">1930</span>
|
|
<span class="normal">1931</span>
|
|
<span class="normal">1932</span>
|
|
<span class="normal">1933</span>
|
|
<span class="normal">1934</span>
|
|
<span class="normal">1935</span>
|
|
<span class="normal">1936</span>
|
|
<span class="normal">1937</span>
|
|
<span class="normal">1938</span>
|
|
<span class="normal">1939</span>
|
|
<span class="normal">1940</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">HCI_Packet</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> Abstract Base class for HCI packets</span>
|
|
<span class="sd"> '''</span>
|
|
|
|
<span class="n">hci_packet_type</span><span class="p">:</span> <span class="nb">int</span>
|
|
|
|
<span class="nd">@staticmethod</span>
|
|
<span class="k">def</span> <span class="nf">from_bytes</span><span class="p">(</span><span class="n">packet</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">)</span> <span class="o">-></span> <span class="n">HCI_Packet</span><span class="p">:</span>
|
|
<span class="n">packet_type</span> <span class="o">=</span> <span class="n">packet</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
|
|
|
|
<span class="k">if</span> <span class="n">packet_type</span> <span class="o">==</span> <span class="n">HCI_COMMAND_PACKET</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">HCI_Command</span><span class="o">.</span><span class="n">from_bytes</span><span class="p">(</span><span class="n">packet</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="n">packet_type</span> <span class="o">==</span> <span class="n">HCI_ACL_DATA_PACKET</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">HCI_AclDataPacket</span><span class="o">.</span><span class="n">from_bytes</span><span class="p">(</span><span class="n">packet</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="n">packet_type</span> <span class="o">==</span> <span class="n">HCI_EVENT_PACKET</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">HCI_Event</span><span class="o">.</span><span class="n">from_bytes</span><span class="p">(</span><span class="n">packet</span><span class="p">)</span>
|
|
|
|
<span class="k">return</span> <span class="n">HCI_CustomPacket</span><span class="p">(</span><span class="n">packet</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__bytes__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bytes</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div><h2 id="hci-commands">HCI Commands<a class="headerlink" href="#hci-commands" title="Permanent link">¶</a></h2>
|
|
<h3 id="hci_command">HCI_Command<a class="headerlink" href="#hci_command" title="Permanent link">¶</a></h3>
|
|
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<a id="bumble.hci.HCI_Command"></a>
|
|
<div class="doc doc-contents first">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><a class="autorefs autorefs-internal" title="bumble.hci.HCI_Packet" href="#bumble.hci.HCI_Packet">HCI_Packet</a></code></p>
|
|
|
|
|
|
<p>See Bluetooth spec @ Vol 2, Part E - 5.4.1 HCI Command Packet</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>bumble/hci.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1955</span>
|
|
<span class="normal">1956</span>
|
|
<span class="normal">1957</span>
|
|
<span class="normal">1958</span>
|
|
<span class="normal">1959</span>
|
|
<span class="normal">1960</span>
|
|
<span class="normal">1961</span>
|
|
<span class="normal">1962</span>
|
|
<span class="normal">1963</span>
|
|
<span class="normal">1964</span>
|
|
<span class="normal">1965</span>
|
|
<span class="normal">1966</span>
|
|
<span class="normal">1967</span>
|
|
<span class="normal">1968</span>
|
|
<span class="normal">1969</span>
|
|
<span class="normal">1970</span>
|
|
<span class="normal">1971</span>
|
|
<span class="normal">1972</span>
|
|
<span class="normal">1973</span>
|
|
<span class="normal">1974</span>
|
|
<span class="normal">1975</span>
|
|
<span class="normal">1976</span>
|
|
<span class="normal">1977</span>
|
|
<span class="normal">1978</span>
|
|
<span class="normal">1979</span>
|
|
<span class="normal">1980</span>
|
|
<span class="normal">1981</span>
|
|
<span class="normal">1982</span>
|
|
<span class="normal">1983</span>
|
|
<span class="normal">1984</span>
|
|
<span class="normal">1985</span>
|
|
<span class="normal">1986</span>
|
|
<span class="normal">1987</span>
|
|
<span class="normal">1988</span>
|
|
<span class="normal">1989</span>
|
|
<span class="normal">1990</span>
|
|
<span class="normal">1991</span>
|
|
<span class="normal">1992</span>
|
|
<span class="normal">1993</span>
|
|
<span class="normal">1994</span>
|
|
<span class="normal">1995</span>
|
|
<span class="normal">1996</span>
|
|
<span class="normal">1997</span>
|
|
<span class="normal">1998</span>
|
|
<span class="normal">1999</span>
|
|
<span class="normal">2000</span>
|
|
<span class="normal">2001</span>
|
|
<span class="normal">2002</span>
|
|
<span class="normal">2003</span>
|
|
<span class="normal">2004</span>
|
|
<span class="normal">2005</span>
|
|
<span class="normal">2006</span>
|
|
<span class="normal">2007</span>
|
|
<span class="normal">2008</span>
|
|
<span class="normal">2009</span>
|
|
<span class="normal">2010</span>
|
|
<span class="normal">2011</span>
|
|
<span class="normal">2012</span>
|
|
<span class="normal">2013</span>
|
|
<span class="normal">2014</span>
|
|
<span class="normal">2015</span>
|
|
<span class="normal">2016</span>
|
|
<span class="normal">2017</span>
|
|
<span class="normal">2018</span>
|
|
<span class="normal">2019</span>
|
|
<span class="normal">2020</span>
|
|
<span class="normal">2021</span>
|
|
<span class="normal">2022</span>
|
|
<span class="normal">2023</span>
|
|
<span class="normal">2024</span>
|
|
<span class="normal">2025</span>
|
|
<span class="normal">2026</span>
|
|
<span class="normal">2027</span>
|
|
<span class="normal">2028</span>
|
|
<span class="normal">2029</span>
|
|
<span class="normal">2030</span>
|
|
<span class="normal">2031</span>
|
|
<span class="normal">2032</span>
|
|
<span class="normal">2033</span>
|
|
<span class="normal">2034</span>
|
|
<span class="normal">2035</span>
|
|
<span class="normal">2036</span>
|
|
<span class="normal">2037</span>
|
|
<span class="normal">2038</span>
|
|
<span class="normal">2039</span>
|
|
<span class="normal">2040</span>
|
|
<span class="normal">2041</span>
|
|
<span class="normal">2042</span>
|
|
<span class="normal">2043</span>
|
|
<span class="normal">2044</span>
|
|
<span class="normal">2045</span>
|
|
<span class="normal">2046</span>
|
|
<span class="normal">2047</span>
|
|
<span class="normal">2048</span>
|
|
<span class="normal">2049</span>
|
|
<span class="normal">2050</span>
|
|
<span class="normal">2051</span>
|
|
<span class="normal">2052</span>
|
|
<span class="normal">2053</span>
|
|
<span class="normal">2054</span>
|
|
<span class="normal">2055</span>
|
|
<span class="normal">2056</span>
|
|
<span class="normal">2057</span>
|
|
<span class="normal">2058</span>
|
|
<span class="normal">2059</span>
|
|
<span class="normal">2060</span>
|
|
<span class="normal">2061</span>
|
|
<span class="normal">2062</span>
|
|
<span class="normal">2063</span>
|
|
<span class="normal">2064</span>
|
|
<span class="normal">2065</span>
|
|
<span class="normal">2066</span>
|
|
<span class="normal">2067</span>
|
|
<span class="normal">2068</span>
|
|
<span class="normal">2069</span>
|
|
<span class="normal">2070</span>
|
|
<span class="normal">2071</span>
|
|
<span class="normal">2072</span>
|
|
<span class="normal">2073</span>
|
|
<span class="normal">2074</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">HCI_Command</span><span class="p">(</span><span class="n">HCI_Packet</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> See Bluetooth spec @ Vol 2, Part E - 5.4.1 HCI Command Packet</span>
|
|
<span class="sd"> '''</span>
|
|
|
|
<span class="n">hci_packet_type</span> <span class="o">=</span> <span class="n">HCI_COMMAND_PACKET</span>
|
|
<span class="n">command_names</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
|
|
<span class="n">command_classes</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">Type</span><span class="p">[</span><span class="n">HCI_Command</span><span class="p">]]</span> <span class="o">=</span> <span class="p">{}</span>
|
|
|
|
<span class="nd">@staticmethod</span>
|
|
<span class="k">def</span> <span class="nf">command</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="p">(),</span> <span class="n">return_parameters_fields</span><span class="o">=</span><span class="p">()):</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> Decorator used to declare and register subclasses</span>
|
|
<span class="sd"> '''</span>
|
|
|
|
<span class="k">def</span> <span class="nf">inner</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
|
|
<span class="bp">cls</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="vm">__name__</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
|
|
<span class="bp">cls</span><span class="o">.</span><span class="n">op_code</span> <span class="o">=</span> <span class="n">key_with_value</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">command_names</span><span class="p">,</span> <span class="bp">cls</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="bp">cls</span><span class="o">.</span><span class="n">op_code</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="sa">f</span><span class="s1">'command </span><span class="si">{</span><span class="bp">cls</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s1"> not found in command_names'</span><span class="p">)</span>
|
|
<span class="bp">cls</span><span class="o">.</span><span class="n">fields</span> <span class="o">=</span> <span class="n">fields</span>
|
|
<span class="bp">cls</span><span class="o">.</span><span class="n">return_parameters_fields</span> <span class="o">=</span> <span class="n">return_parameters_fields</span>
|
|
|
|
<span class="c1"># Patch the __init__ method to fix the op_code</span>
|
|
<span class="k">if</span> <span class="n">fields</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
|
|
<span class="k">def</span> <span class="nf">init</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parameters</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">HCI_Command</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="bp">cls</span><span class="o">.</span><span class="n">op_code</span><span class="p">,</span> <span class="n">parameters</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
|
|
|
<span class="bp">cls</span><span class="o">.</span><span class="fm">__init__</span> <span class="o">=</span> <span class="n">init</span>
|
|
|
|
<span class="c1"># Register a factory for this class</span>
|
|
<span class="n">HCI_Command</span><span class="o">.</span><span class="n">command_classes</span><span class="p">[</span><span class="bp">cls</span><span class="o">.</span><span class="n">op_code</span><span class="p">]</span> <span class="o">=</span> <span class="bp">cls</span>
|
|
|
|
<span class="k">return</span> <span class="bp">cls</span>
|
|
|
|
<span class="k">return</span> <span class="n">inner</span>
|
|
|
|
<span class="nd">@staticmethod</span>
|
|
<span class="k">def</span> <span class="nf">command_map</span><span class="p">(</span><span class="n">symbols</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-></span> <span class="n">Dict</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">str</span><span class="p">]:</span>
|
|
<span class="k">return</span> <span class="p">{</span>
|
|
<span class="n">command_code</span><span class="p">:</span> <span class="n">command_name</span>
|
|
<span class="k">for</span> <span class="p">(</span><span class="n">command_name</span><span class="p">,</span> <span class="n">command_code</span><span class="p">)</span> <span class="ow">in</span> <span class="n">symbols</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="n">command_name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'HCI_'</span><span class="p">)</span> <span class="ow">and</span> <span class="n">command_name</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'_COMMAND'</span><span class="p">)</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="nd">@classmethod</span>
|
|
<span class="k">def</span> <span class="nf">register_commands</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">symbols</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="bp">cls</span><span class="o">.</span><span class="n">command_names</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">command_map</span><span class="p">(</span><span class="n">symbols</span><span class="p">))</span>
|
|
|
|
<span class="nd">@staticmethod</span>
|
|
<span class="k">def</span> <span class="nf">from_bytes</span><span class="p">(</span><span class="n">packet</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">)</span> <span class="o">-></span> <span class="n">HCI_Command</span><span class="p">:</span>
|
|
<span class="n">op_code</span><span class="p">,</span> <span class="n">length</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack_from</span><span class="p">(</span><span class="s1">'<HB'</span><span class="p">,</span> <span class="n">packet</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
|
|
<span class="n">parameters</span> <span class="o">=</span> <span class="n">packet</span><span class="p">[</span><span class="mi">4</span><span class="p">:]</span>
|
|
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">parameters</span><span class="p">)</span> <span class="o">!=</span> <span class="n">length</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'invalid packet length'</span><span class="p">)</span>
|
|
|
|
<span class="c1"># Look for a registered class</span>
|
|
<span class="bp">cls</span> <span class="o">=</span> <span class="n">HCI_Command</span><span class="o">.</span><span class="n">command_classes</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">op_code</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="bp">cls</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="c1"># No class registered, just use a generic instance</span>
|
|
<span class="k">return</span> <span class="n">HCI_Command</span><span class="p">(</span><span class="n">op_code</span><span class="p">,</span> <span class="n">parameters</span><span class="p">)</span>
|
|
|
|
<span class="c1"># Create a new instance</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="n">fields</span> <span class="o">:=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="s1">'fields'</span><span class="p">,</span> <span class="kc">None</span><span class="p">))</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="bp">self</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="fm">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span>
|
|
<span class="n">HCI_Command</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">op_code</span><span class="p">,</span> <span class="n">parameters</span><span class="p">)</span>
|
|
<span class="n">HCI_Object</span><span class="o">.</span><span class="n">init_from_bytes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parameters</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">fields</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="bp">self</span>
|
|
|
|
<span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">from_parameters</span><span class="p">(</span><span class="n">parameters</span><span class="p">)</span> <span class="c1"># type: ignore</span>
|
|
|
|
<span class="nd">@staticmethod</span>
|
|
<span class="k">def</span> <span class="nf">command_name</span><span class="p">(</span><span class="n">op_code</span><span class="p">):</span>
|
|
<span class="n">name</span> <span class="o">=</span> <span class="n">HCI_Command</span><span class="o">.</span><span class="n">command_names</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">op_code</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">name</span>
|
|
<span class="k">return</span> <span class="sa">f</span><span class="s1">'[OGF=0x</span><span class="si">{</span><span class="n">op_code</span><span class="w"> </span><span class="o">>></span><span class="w"> </span><span class="mi">10</span><span class="si">:</span><span class="s1">02x</span><span class="si">}</span><span class="s1">, OCF=0x</span><span class="si">{</span><span class="n">op_code</span><span class="w"> </span><span class="o">&</span><span class="w"> </span><span class="mh">0x3FF</span><span class="si">:</span><span class="s1">04x</span><span class="si">}</span><span class="s1">]'</span>
|
|
|
|
<span class="nd">@classmethod</span>
|
|
<span class="k">def</span> <span class="nf">create_return_parameters</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">HCI_Object</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">return_parameters_fields</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
|
|
|
<span class="nd">@classmethod</span>
|
|
<span class="k">def</span> <span class="nf">parse_return_parameters</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">parameters</span><span class="p">):</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="bp">cls</span><span class="o">.</span><span class="n">return_parameters_fields</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="kc">None</span>
|
|
<span class="n">return_parameters</span> <span class="o">=</span> <span class="n">HCI_Object</span><span class="o">.</span><span class="n">from_bytes</span><span class="p">(</span>
|
|
<span class="n">parameters</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="bp">cls</span><span class="o">.</span><span class="n">return_parameters_fields</span>
|
|
<span class="p">)</span>
|
|
<span class="n">return_parameters</span><span class="o">.</span><span class="n">fields</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">return_parameters_fields</span>
|
|
<span class="k">return</span> <span class="n">return_parameters</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">op_code</span><span class="p">,</span> <span class="n">parameters</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
|
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">HCI_Command</span><span class="o">.</span><span class="n">command_name</span><span class="p">(</span><span class="n">op_code</span><span class="p">))</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="n">fields</span> <span class="o">:=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">'fields'</span><span class="p">,</span> <span class="kc">None</span><span class="p">))</span> <span class="ow">and</span> <span class="n">kwargs</span><span class="p">:</span>
|
|
<span class="n">HCI_Object</span><span class="o">.</span><span class="n">init_from_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fields</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">parameters</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="n">parameters</span> <span class="o">=</span> <span class="n">HCI_Object</span><span class="o">.</span><span class="n">dict_to_bytes</span><span class="p">(</span><span class="n">kwargs</span><span class="p">,</span> <span class="n">fields</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">op_code</span> <span class="o">=</span> <span class="n">op_code</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">parameters</span> <span class="o">=</span> <span class="n">parameters</span>
|
|
|
|
<span class="k">def</span> <span class="nf">to_bytes</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="n">parameters</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">parameters</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">parameters</span>
|
|
<span class="k">return</span> <span class="p">(</span>
|
|
<span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'<BHB'</span><span class="p">,</span> <span class="n">HCI_COMMAND_PACKET</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">op_code</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">parameters</span><span class="p">))</span>
|
|
<span class="o">+</span> <span class="n">parameters</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__bytes__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">to_bytes</span><span class="p">()</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="n">color</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s1">'green'</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">fields</span> <span class="o">:=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">'fields'</span><span class="p">,</span> <span class="kc">None</span><span class="p">):</span>
|
|
<span class="n">result</span> <span class="o">+=</span> <span class="s1">':</span><span class="se">\n</span><span class="s1">'</span> <span class="o">+</span> <span class="n">HCI_Object</span><span class="o">.</span><span class="n">format_fields</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__dict__</span><span class="p">,</span> <span class="n">fields</span><span class="p">,</span> <span class="s1">' '</span><span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">parameters</span><span class="p">:</span>
|
|
<span class="n">result</span> <span class="o">+=</span> <span class="sa">f</span><span class="s1">': </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">parameters</span><span class="o">.</span><span class="n">hex</span><span class="p">()</span><span class="si">}</span><span class="s1">'</span>
|
|
<span class="k">return</span> <span class="n">result</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
|
|
<h2 id="bumble.hci.HCI_Command.command" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">command</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="p">(),</span> <span class="n">return_parameters_fields</span><span class="o">=</span><span class="p">())</span></code>
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small>
|
|
</span>
|
|
|
|
<a href="#bumble.hci.HCI_Command.command" class="headerlink" title="Permanent link">¶</a></h2>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Decorator used to declare and register subclasses</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>bumble/hci.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1964</span>
|
|
<span class="normal">1965</span>
|
|
<span class="normal">1966</span>
|
|
<span class="normal">1967</span>
|
|
<span class="normal">1968</span>
|
|
<span class="normal">1969</span>
|
|
<span class="normal">1970</span>
|
|
<span class="normal">1971</span>
|
|
<span class="normal">1972</span>
|
|
<span class="normal">1973</span>
|
|
<span class="normal">1974</span>
|
|
<span class="normal">1975</span>
|
|
<span class="normal">1976</span>
|
|
<span class="normal">1977</span>
|
|
<span class="normal">1978</span>
|
|
<span class="normal">1979</span>
|
|
<span class="normal">1980</span>
|
|
<span class="normal">1981</span>
|
|
<span class="normal">1982</span>
|
|
<span class="normal">1983</span>
|
|
<span class="normal">1984</span>
|
|
<span class="normal">1985</span>
|
|
<span class="normal">1986</span>
|
|
<span class="normal">1987</span>
|
|
<span class="normal">1988</span>
|
|
<span class="normal">1989</span>
|
|
<span class="normal">1990</span>
|
|
<span class="normal">1991</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@staticmethod</span>
|
|
<span class="k">def</span> <span class="nf">command</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="p">(),</span> <span class="n">return_parameters_fields</span><span class="o">=</span><span class="p">()):</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> Decorator used to declare and register subclasses</span>
|
|
<span class="sd"> '''</span>
|
|
|
|
<span class="k">def</span> <span class="nf">inner</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
|
|
<span class="bp">cls</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="vm">__name__</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
|
|
<span class="bp">cls</span><span class="o">.</span><span class="n">op_code</span> <span class="o">=</span> <span class="n">key_with_value</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">command_names</span><span class="p">,</span> <span class="bp">cls</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="bp">cls</span><span class="o">.</span><span class="n">op_code</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="sa">f</span><span class="s1">'command </span><span class="si">{</span><span class="bp">cls</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s1"> not found in command_names'</span><span class="p">)</span>
|
|
<span class="bp">cls</span><span class="o">.</span><span class="n">fields</span> <span class="o">=</span> <span class="n">fields</span>
|
|
<span class="bp">cls</span><span class="o">.</span><span class="n">return_parameters_fields</span> <span class="o">=</span> <span class="n">return_parameters_fields</span>
|
|
|
|
<span class="c1"># Patch the __init__ method to fix the op_code</span>
|
|
<span class="k">if</span> <span class="n">fields</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
|
|
<span class="k">def</span> <span class="nf">init</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parameters</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">HCI_Command</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="bp">cls</span><span class="o">.</span><span class="n">op_code</span><span class="p">,</span> <span class="n">parameters</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
|
|
|
<span class="bp">cls</span><span class="o">.</span><span class="fm">__init__</span> <span class="o">=</span> <span class="n">init</span>
|
|
|
|
<span class="c1"># Register a factory for this class</span>
|
|
<span class="n">HCI_Command</span><span class="o">.</span><span class="n">command_classes</span><span class="p">[</span><span class="bp">cls</span><span class="o">.</span><span class="n">op_code</span><span class="p">]</span> <span class="o">=</span> <span class="bp">cls</span>
|
|
|
|
<span class="k">return</span> <span class="bp">cls</span>
|
|
|
|
<span class="k">return</span> <span class="n">inner</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div><h3 id="hci_disconnect_command">HCI_Disconnect_Command<a class="headerlink" href="#hci_disconnect_command" title="Permanent link">¶</a></h3>
|
|
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<a id="bumble.hci.HCI_Disconnect_Command"></a>
|
|
<div class="doc doc-contents first">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><a class="autorefs autorefs-internal" title="bumble.hci.HCI_Command" href="#bumble.hci.HCI_Command">HCI_Command</a></code></p>
|
|
|
|
|
|
<p>See Bluetooth spec @ 7.1.6 Disconnect Command</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>bumble/hci.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">2120</span>
|
|
<span class="normal">2121</span>
|
|
<span class="normal">2122</span>
|
|
<span class="normal">2123</span>
|
|
<span class="normal">2124</span>
|
|
<span class="normal">2125</span>
|
|
<span class="normal">2126</span>
|
|
<span class="normal">2127</span>
|
|
<span class="normal">2128</span>
|
|
<span class="normal">2129</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@HCI_Command</span><span class="o">.</span><span class="n">command</span><span class="p">(</span>
|
|
<span class="p">[</span>
|
|
<span class="p">(</span><span class="s1">'connection_handle'</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span>
|
|
<span class="p">(</span><span class="s1">'reason'</span><span class="p">,</span> <span class="p">{</span><span class="s1">'size'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">'mapper'</span><span class="p">:</span> <span class="n">HCI_Constant</span><span class="o">.</span><span class="n">error_name</span><span class="p">}),</span>
|
|
<span class="p">]</span>
|
|
<span class="p">)</span>
|
|
<span class="k">class</span> <span class="nc">HCI_Disconnect_Command</span><span class="p">(</span><span class="n">HCI_Command</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> See Bluetooth spec @ 7.1.6 Disconnect Command</span>
|
|
<span class="sd"> '''</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
</main>
|
|
|
|
|
|
<footer class="md-footer">
|
|
|
|
<div class="md-footer-nav">
|
|
<nav class="md-footer-nav__inner md-grid">
|
|
|
|
<a href="examples.html" title="Examples" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
|
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
|
|
</div>
|
|
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
|
|
<span class="md-flex__ellipsis">
|
|
<span class="md-footer-nav__direction">
|
|
Previous
|
|
</span>
|
|
Examples
|
|
</span>
|
|
</div>
|
|
</a>
|
|
|
|
|
|
<a href="../apps_and_tools/index.html" title="Overview" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
|
|
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
|
|
<span class="md-flex__ellipsis">
|
|
<span class="md-footer-nav__direction">
|
|
Next
|
|
</span>
|
|
Overview
|
|
</span>
|
|
</div>
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
|
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
|
|
</div>
|
|
</a>
|
|
|
|
</nav>
|
|
</div>
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-footer-copyright">
|
|
|
|
<div class="md-footer-copyright__highlight">
|
|
Copyright 2021-2023 Google LLC
|
|
</div>
|
|
|
|
</div>
|
|
<div class="md-social">
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
<div class="md-dialog" data-md-component="dialog">
|
|
<div class="md-dialog__inner md-typeset"></div>
|
|
</div>
|
|
|
|
|
|
<script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
|
|
|
|
|
|
<script src="../assets/javascripts/bundle.aecac24b.min.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |