forked from auracaster/bumble_mirror
Josh Wu
3947 lines
130 KiB
HTML
3947 lines
130 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.6.1, mkdocs-material-9.7.1">
|
|
|
|
|
|
|
|
<title>Reference - Bumble</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/stylesheets/main.484c7ddc.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">
|
|
|
|
|
|
<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 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></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>
|
|
|
|
|
|
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
|
|
|
|
|
|
|
|
|
<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 7.1.0 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 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></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 7.1.0 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 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></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" >
|
|
|
|
|
|
<div class="md-nav__link md-nav__container">
|
|
<a href="../use_cases/index.html" class="md-nav__link ">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Use Cases
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
</div>
|
|
|
|
<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/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" >
|
|
|
|
|
|
<div class="md-nav__link md-nav__container">
|
|
<a href="../transports/index.html" class="md-nav__link ">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Transports
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
</div>
|
|
|
|
<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/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" >
|
|
|
|
|
|
<div class="md-nav__link md-nav__container">
|
|
<a href="../drivers/index.html" class="md-nav__link ">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Drivers
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="0">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
</div>
|
|
|
|
<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/realtek.html" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Realtek
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../drivers/intel.html" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Intel
|
|
|
|
|
|
|
|
</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" >
|
|
|
|
|
|
<div class="md-nav__link md-nav__container">
|
|
<a href="../apps_and_tools/index.html" class="md-nav__link ">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Apps & Tools
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="0">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
</div>
|
|
|
|
<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/auracast.html" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Auracast
|
|
|
|
|
|
|
|
</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>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" >
|
|
|
|
|
|
<div class="md-nav__link md-nav__container">
|
|
<a href="../hardware/index.html" class="md-nav__link ">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Hardware
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
|
|
</div>
|
|
|
|
<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>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" >
|
|
|
|
|
|
<div class="md-nav__link md-nav__container">
|
|
<a href="../platforms/index.html" class="md-nav__link ">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Platforms
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="0">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
</div>
|
|
|
|
<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/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" >
|
|
|
|
|
|
<div class="md-nav__link md-nav__container">
|
|
<a href="../examples/index.html" class="md-nav__link ">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Examples
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
|
|
</div>
|
|
|
|
<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>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_13" >
|
|
|
|
|
|
<div class="md-nav__link md-nav__container">
|
|
<a href="../extras/index.html" class="md-nav__link ">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Extras
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
<label class="md-nav__link " for="__nav_13" id="__nav_13_label" tabindex="0">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
</div>
|
|
|
|
<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/android_remote_hci.html" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Android Remote HCI
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../extras/android_bt_bench.html" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Android BT Bench
|
|
|
|
|
|
|
|
</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" >
|
|
|
|
|
|
<div class="md-nav__link md-nav__container">
|
|
<a href="../hive/index.html" class="md-nav__link ">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Hive
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
<label class="md-nav__link " for="__nav_14" id="__nav_14_label" tabindex="0">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
</div>
|
|
|
|
<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/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="mkdocstrings-source">
|
|
<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">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>
|
|
<span class="normal">2075</span>
|
|
<span class="normal">2076</span>
|
|
<span class="normal">2077</span>
|
|
<span class="normal">2078</span>
|
|
<span class="normal">2079</span>
|
|
<span class="normal">2080</span>
|
|
<span class="normal">2081</span>
|
|
<span class="normal">2082</span>
|
|
<span class="normal">2083</span>
|
|
<span class="normal">2084</span>
|
|
<span class="normal">2085</span>
|
|
<span class="normal">2086</span>
|
|
<span class="normal">2087</span>
|
|
<span class="normal">2088</span>
|
|
<span class="normal">2089</span>
|
|
<span class="normal">2090</span>
|
|
<span class="normal">2091</span>
|
|
<span class="normal">2092</span>
|
|
<span class="normal">2093</span>
|
|
<span class="normal">2094</span>
|
|
<span class="normal">2095</span>
|
|
<span class="normal">2096</span>
|
|
<span class="normal">2097</span>
|
|
<span class="normal">2098</span>
|
|
<span class="normal">2099</span>
|
|
<span class="normal">2100</span>
|
|
<span class="normal">2101</span>
|
|
<span class="normal">2102</span>
|
|
<span class="normal">2103</span>
|
|
<span class="normal">2104</span>
|
|
<span class="normal">2105</span>
|
|
<span class="normal">2106</span>
|
|
<span class="normal">2107</span>
|
|
<span class="normal">2108</span>
|
|
<span class="normal">2109</span>
|
|
<span class="normal">2110</span>
|
|
<span class="normal">2111</span>
|
|
<span class="normal">2112</span>
|
|
<span class="normal">2113</span>
|
|
<span class="normal">2114</span>
|
|
<span class="normal">2115</span>
|
|
<span class="normal">2116</span>
|
|
<span class="normal">2117</span>
|
|
<span class="normal">2118</span>
|
|
<span class="normal">2119</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>
|
|
<span class="normal">2130</span>
|
|
<span class="normal">2131</span>
|
|
<span class="normal">2132</span>
|
|
<span class="normal">2133</span>
|
|
<span class="normal">2134</span>
|
|
<span class="normal">2135</span>
|
|
<span class="normal">2136</span>
|
|
<span class="normal">2137</span>
|
|
<span class="normal">2138</span>
|
|
<span class="normal">2139</span>
|
|
<span class="normal">2140</span>
|
|
<span class="normal">2141</span>
|
|
<span class="normal">2142</span>
|
|
<span class="normal">2143</span>
|
|
<span class="normal">2144</span>
|
|
<span class="normal">2145</span>
|
|
<span class="normal">2146</span>
|
|
<span class="normal">2147</span>
|
|
<span class="normal">2148</span>
|
|
<span class="normal">2149</span>
|
|
<span class="normal">2150</span>
|
|
<span class="normal">2151</span>
|
|
<span class="normal">2152</span>
|
|
<span class="normal">2153</span>
|
|
<span class="normal">2154</span>
|
|
<span class="normal">2155</span>
|
|
<span class="normal">2156</span>
|
|
<span class="normal">2157</span>
|
|
<span class="normal">2158</span>
|
|
<span class="normal">2159</span>
|
|
<span class="normal">2160</span>
|
|
<span class="normal">2161</span>
|
|
<span class="normal">2162</span>
|
|
<span class="normal">2163</span>
|
|
<span class="normal">2164</span>
|
|
<span class="normal">2165</span>
|
|
<span class="normal">2166</span>
|
|
<span class="normal">2167</span>
|
|
<span class="normal">2168</span>
|
|
<span class="normal">2169</span>
|
|
<span class="normal">2170</span>
|
|
<span class="normal">2171</span>
|
|
<span class="normal">2172</span>
|
|
<span class="normal">2173</span>
|
|
<span class="normal">2174</span>
|
|
<span class="normal">2175</span>
|
|
<span class="normal">2176</span>
|
|
<span class="normal">2177</span>
|
|
<span class="normal">2178</span>
|
|
<span class="normal">2179</span>
|
|
<span class="normal">2180</span>
|
|
<span class="normal">2181</span>
|
|
<span class="normal">2182</span>
|
|
<span class="normal">2183</span>
|
|
<span class="normal">2184</span>
|
|
<span class="normal">2185</span>
|
|
<span class="normal">2186</span>
|
|
<span class="normal">2187</span>
|
|
<span class="normal">2188</span>
|
|
<span class="normal">2189</span>
|
|
<span class="normal">2190</span>
|
|
<span class="normal">2191</span>
|
|
<span class="normal">2192</span>
|
|
<span class="normal">2193</span>
|
|
<span class="normal">2194</span>
|
|
<span class="normal">2195</span>
|
|
<span class="normal">2196</span>
|
|
<span class="normal">2197</span>
|
|
<span class="normal">2198</span>
|
|
<span class="normal">2199</span>
|
|
<span class="normal">2200</span>
|
|
<span class="normal">2201</span>
|
|
<span class="normal">2202</span>
|
|
<span class="normal">2203</span>
|
|
<span class="normal">2204</span>
|
|
<span class="normal">2205</span>
|
|
<span class="normal">2206</span>
|
|
<span class="normal">2207</span>
|
|
<span class="normal">2208</span>
|
|
<span class="normal">2209</span>
|
|
<span class="normal">2210</span>
|
|
<span class="normal">2211</span>
|
|
<span class="normal">2212</span>
|
|
<span class="normal">2213</span>
|
|
<span class="normal">2214</span>
|
|
<span class="normal">2215</span>
|
|
<span class="normal">2216</span>
|
|
<span class="normal">2217</span>
|
|
<span class="normal">2218</span>
|
|
<span class="normal">2219</span>
|
|
<span class="normal">2220</span>
|
|
<span class="normal">2221</span>
|
|
<span class="normal">2222</span>
|
|
<span class="normal">2223</span>
|
|
<span class="normal">2224</span>
|
|
<span class="normal">2225</span>
|
|
<span class="normal">2226</span>
|
|
<span class="normal">2227</span>
|
|
<span class="normal">2228</span>
|
|
<span class="normal">2229</span>
|
|
<span class="normal">2230</span>
|
|
<span class="normal">2231</span>
|
|
<span class="normal">2232</span>
|
|
<span class="normal">2233</span>
|
|
<span class="normal">2234</span>
|
|
<span class="normal">2235</span>
|
|
<span class="normal">2236</span>
|
|
<span class="normal">2237</span>
|
|
<span class="normal">2238</span>
|
|
<span class="normal">2239</span>
|
|
<span class="normal">2240</span>
|
|
<span class="normal">2241</span>
|
|
<span class="normal">2242</span>
|
|
<span class="normal">2243</span>
|
|
<span class="normal">2244</span>
|
|
<span class="normal">2245</span>
|
|
<span class="normal">2246</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span><span class="w"> </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="n">AddressType</span><span class="o">.</span><span class="n">PUBLIC_DEVICE</span>
|
|
<span class="n">RANDOM_DEVICE_ADDRESS</span> <span class="o">=</span> <span class="n">AddressType</span><span class="o">.</span><span class="n">RANDOM_DEVICE</span>
|
|
<span class="n">PUBLIC_IDENTITY_ADDRESS</span> <span class="o">=</span> <span class="n">AddressType</span><span class="o">.</span><span class="n">PUBLIC_IDENTITY</span>
|
|
<span class="n">RANDOM_IDENTITY_ADDRESS</span> <span class="o">=</span> <span class="n">AddressType</span><span class="o">.</span><span class="n">RANDOM_IDENTITY</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">@classmethod</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">address_type_name</span><span class="p">(</span><span class="bp">cls</span><span class="p">:</span> <span class="nb">type</span><span class="p">[</span><span class="n">Self</span><span class="p">],</span> <span class="n">address_type</span><span class="p">:</span> <span class="nb">int</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="n">AddressType</span><span class="p">(</span><span class="n">address_type</span><span class="p">)</span><span class="o">.</span><span class="n">name</span>
|
|
|
|
<span class="nd">@classmethod</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">from_string_for_transport</span><span class="p">(</span>
|
|
<span class="bp">cls</span><span class="p">:</span> <span class="nb">type</span><span class="p">[</span><span class="n">Self</span><span class="p">],</span> <span class="n">string</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">transport</span><span class="p">:</span> <span class="n">PhysicalTransport</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">Self</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">transport</span> <span class="o">==</span> <span class="n">PhysicalTransport</span><span class="o">.</span><span class="n">BR_EDR</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="bp">cls</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">@classmethod</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">parse_address</span><span class="p">(</span><span class="bp">cls</span><span class="p">:</span> <span class="nb">type</span><span class="p">[</span><span class="n">Self</span><span class="p">],</span> <span class="n">data</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">Self</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="bp">cls</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">@classmethod</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">parse_random_address</span><span class="p">(</span>
|
|
<span class="bp">cls</span><span class="p">:</span> <span class="nb">type</span><span class="p">[</span><span class="n">Self</span><span class="p">],</span> <span class="n">data</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">Self</span><span class="p">]:</span>
|
|
<span class="k">return</span> <span class="bp">cls</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">RANDOM_DEVICE_ADDRESS</span><span class="p">)</span>
|
|
|
|
<span class="nd">@classmethod</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">parse_address_with_type</span><span class="p">(</span>
|
|
<span class="bp">cls</span><span class="p">:</span> <span class="nb">type</span><span class="p">[</span><span class="n">Self</span><span class="p">],</span> <span class="n">data</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">address_type</span><span class="p">:</span> <span class="n">AddressType</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">Self</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="bp">cls</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">@classmethod</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">parse_address_preceded_by_type</span><span class="p">(</span>
|
|
<span class="bp">cls</span><span class="p">:</span> <span class="nb">type</span><span class="p">[</span><span class="n">Self</span><span class="p">],</span> <span class="n">data</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">Self</span><span class="p">]:</span>
|
|
<span class="n">address_type</span> <span class="o">=</span> <span class="n">AddressType</span><span class="p">(</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="bp">cls</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="nd">@classmethod</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">generate_static_address</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span> <span class="o">-></span> <span class="n">Address</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">'''Generates Random Static Address, with the 2 most significant bits of 0b11.</span>
|
|
|
|
<span class="sd"> See Bluetooth spec, Vol 6, Part B - Table 1.2.</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="n">address_bytes</span> <span class="o">=</span> <span class="n">secrets</span><span class="o">.</span><span class="n">token_bytes</span><span class="p">(</span><span class="mi">6</span><span class="p">)</span>
|
|
<span class="n">address_bytes</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="nb">bytes</span><span class="p">([</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="mb">0b11000000</span><span class="p">])</span>
|
|
<span class="k">return</span> <span class="n">Address</span><span class="p">(</span>
|
|
<span class="n">address</span><span class="o">=</span><span class="n">address_bytes</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="p">)</span>
|
|
|
|
<span class="nd">@classmethod</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">generate_private_address</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">irk</span><span class="p">:</span> <span class="nb">bytes</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span><span class="p">)</span> <span class="o">-></span> <span class="n">Address</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">'''Generates Random Private MAC Address.</span>
|
|
|
|
<span class="sd"> If IRK is present, a Resolvable Private Address, with the 2 most significant</span>
|
|
<span class="sd"> bits of 0b01 will be generated. Otherwise, a Non-resolvable Private Address,</span>
|
|
<span class="sd"> with the 2 most significant bits of 0b00 will be generated.</span>
|
|
|
|
<span class="sd"> See Bluetooth spec, Vol 6, Part B - Table 1.2.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> irk: Local Identity Resolving Key(IRK), in little-endian. If not set, a</span>
|
|
<span class="sd"> non-resolvable address will be generated.</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="k">if</span> <span class="n">irk</span><span class="p">:</span>
|
|
<span class="n">prand</span> <span class="o">=</span> <span class="n">crypto</span><span class="o">.</span><span class="n">generate_prand</span><span class="p">()</span>
|
|
<span class="n">address_bytes</span> <span class="o">=</span> <span class="n">crypto</span><span class="o">.</span><span class="n">ah</span><span class="p">(</span><span class="n">irk</span><span class="p">,</span> <span class="n">prand</span><span class="p">)</span> <span class="o">+</span> <span class="n">prand</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">address_bytes</span> <span class="o">=</span> <span class="n">secrets</span><span class="o">.</span><span class="n">token_bytes</span><span class="p">(</span><span class="mi">6</span><span class="p">)</span>
|
|
<span class="n">address_bytes</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="nb">bytes</span><span class="p">([</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="mb">0b00111111</span><span class="p">])</span>
|
|
|
|
<span class="k">return</span> <span class="n">Address</span><span class="p">(</span>
|
|
<span class="n">address</span><span class="o">=</span><span class="n">address_bytes</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="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </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="n">AddressType</span> <span class="o">=</span> <span class="n">RANDOM_DEVICE_ADDRESS</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="kc">None</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="n">InvalidArgumentError</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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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">address_bytes</span>
|
|
|
|
<span class="k">def</span><span class="w"> </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="w"> </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="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">Address</span><span class="p">)</span>
|
|
<span class="ow">and</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="w"> </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>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="sa">f</span><span class="s1">'Address(</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">to_string</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span><span class="si">}</span><span class="s1">/</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">address_type_name</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="si">}</span><span class="s1">)'</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="mkdocstrings-source">
|
|
<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">2157</span>
|
|
<span class="normal">2158</span>
|
|
<span class="normal">2159</span>
|
|
<span class="normal">2160</span>
|
|
<span class="normal">2161</span>
|
|
<span class="normal">2162</span>
|
|
<span class="normal">2163</span>
|
|
<span class="normal">2164</span>
|
|
<span class="normal">2165</span>
|
|
<span class="normal">2166</span>
|
|
<span class="normal">2167</span>
|
|
<span class="normal">2168</span>
|
|
<span class="normal">2169</span>
|
|
<span class="normal">2170</span>
|
|
<span class="normal">2171</span>
|
|
<span class="normal">2172</span>
|
|
<span class="normal">2173</span>
|
|
<span class="normal">2174</span>
|
|
<span class="normal">2175</span>
|
|
<span class="normal">2176</span>
|
|
<span class="normal">2177</span>
|
|
<span class="normal">2178</span>
|
|
<span class="normal">2179</span>
|
|
<span class="normal">2180</span>
|
|
<span class="normal">2181</span>
|
|
<span class="normal">2182</span>
|
|
<span class="normal">2183</span>
|
|
<span class="normal">2184</span>
|
|
<span class="normal">2185</span>
|
|
<span class="normal">2186</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span><span class="w"> </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="n">AddressType</span> <span class="o">=</span> <span class="n">RANDOM_DEVICE_ADDRESS</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="kc">None</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="n">InvalidArgumentError</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.generate_private_address" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">generate_private_address</span><span class="p">(</span><span class="n">irk</span><span class="o">=</span><span class="sa">b</span><span class="s1">''</span><span class="p">)</span></code>
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
|
</span>
|
|
|
|
<a href="#bumble.hci.Address.generate_private_address" class="headerlink" title="Permanent link">¶</a></h2>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Generates Random Private MAC Address.</p>
|
|
<p>If IRK is present, a Resolvable Private Address, with the 2 most significant
|
|
bits of 0b01 will be generated. Otherwise, a Non-resolvable Private Address,
|
|
with the 2 most significant bits of 0b00 will be generated.</p>
|
|
<p>See Bluetooth spec, Vol 6, Part B - Table 1.2.</p>
|
|
|
|
|
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>irk</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="bytes">bytes</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Local Identity Resolving Key(IRK), in little-endian. If not set, a</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>b''</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<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">2132</span>
|
|
<span class="normal">2133</span>
|
|
<span class="normal">2134</span>
|
|
<span class="normal">2135</span>
|
|
<span class="normal">2136</span>
|
|
<span class="normal">2137</span>
|
|
<span class="normal">2138</span>
|
|
<span class="normal">2139</span>
|
|
<span class="normal">2140</span>
|
|
<span class="normal">2141</span>
|
|
<span class="normal">2142</span>
|
|
<span class="normal">2143</span>
|
|
<span class="normal">2144</span>
|
|
<span class="normal">2145</span>
|
|
<span class="normal">2146</span>
|
|
<span class="normal">2147</span>
|
|
<span class="normal">2148</span>
|
|
<span class="normal">2149</span>
|
|
<span class="normal">2150</span>
|
|
<span class="normal">2151</span>
|
|
<span class="normal">2152</span>
|
|
<span class="normal">2153</span>
|
|
<span class="normal">2154</span>
|
|
<span class="normal">2155</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@classmethod</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">generate_private_address</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">irk</span><span class="p">:</span> <span class="nb">bytes</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span><span class="p">)</span> <span class="o">-></span> <span class="n">Address</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">'''Generates Random Private MAC Address.</span>
|
|
|
|
<span class="sd"> If IRK is present, a Resolvable Private Address, with the 2 most significant</span>
|
|
<span class="sd"> bits of 0b01 will be generated. Otherwise, a Non-resolvable Private Address,</span>
|
|
<span class="sd"> with the 2 most significant bits of 0b00 will be generated.</span>
|
|
|
|
<span class="sd"> See Bluetooth spec, Vol 6, Part B - Table 1.2.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> irk: Local Identity Resolving Key(IRK), in little-endian. If not set, a</span>
|
|
<span class="sd"> non-resolvable address will be generated.</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="k">if</span> <span class="n">irk</span><span class="p">:</span>
|
|
<span class="n">prand</span> <span class="o">=</span> <span class="n">crypto</span><span class="o">.</span><span class="n">generate_prand</span><span class="p">()</span>
|
|
<span class="n">address_bytes</span> <span class="o">=</span> <span class="n">crypto</span><span class="o">.</span><span class="n">ah</span><span class="p">(</span><span class="n">irk</span><span class="p">,</span> <span class="n">prand</span><span class="p">)</span> <span class="o">+</span> <span class="n">prand</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">address_bytes</span> <span class="o">=</span> <span class="n">secrets</span><span class="o">.</span><span class="n">token_bytes</span><span class="p">(</span><span class="mi">6</span><span class="p">)</span>
|
|
<span class="n">address_bytes</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="nb">bytes</span><span class="p">([</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="mb">0b00111111</span><span class="p">])</span>
|
|
|
|
<span class="k">return</span> <span class="n">Address</span><span class="p">(</span>
|
|
<span class="n">address</span><span class="o">=</span><span class="n">address_bytes</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="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h2 id="bumble.hci.Address.generate_static_address" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">generate_static_address</span><span class="p">()</span></code>
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
|
</span>
|
|
|
|
<a href="#bumble.hci.Address.generate_static_address" class="headerlink" title="Permanent link">¶</a></h2>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Generates Random Static Address, with the 2 most significant bits of 0b11.</p>
|
|
<p>See Bluetooth spec, Vol 6, Part B - Table 1.2.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<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>
|
|
<span class="normal">2130</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@classmethod</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">generate_static_address</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span> <span class="o">-></span> <span class="n">Address</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">'''Generates Random Static Address, with the 2 most significant bits of 0b11.</span>
|
|
|
|
<span class="sd"> See Bluetooth spec, Vol 6, Part B - Table 1.2.</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="n">address_bytes</span> <span class="o">=</span> <span class="n">secrets</span><span class="o">.</span><span class="n">token_bytes</span><span class="p">(</span><span class="mi">6</span><span class="p">)</span>
|
|
<span class="n">address_bytes</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="nb">bytes</span><span class="p">([</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="mb">0b11000000</span><span class="p">])</span>
|
|
<span class="k">return</span> <span class="n">Address</span><span class="p">(</span>
|
|
<span class="n">address</span><span class="o">=</span><span class="n">address_bytes</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="p">)</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="mkdocstrings-source">
|
|
<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">2219</span>
|
|
<span class="normal">2220</span>
|
|
<span class="normal">2221</span>
|
|
<span class="normal">2222</span>
|
|
<span class="normal">2223</span>
|
|
<span class="normal">2224</span>
|
|
<span class="normal">2225</span>
|
|
<span class="normal">2226</span>
|
|
<span class="normal">2227</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span><span class="w"> </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="mkdocstrings-source">
|
|
<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">2279</span>
|
|
<span class="normal">2280</span>
|
|
<span class="normal">2281</span>
|
|
<span class="normal">2282</span>
|
|
<span class="normal">2283</span>
|
|
<span class="normal">2284</span>
|
|
<span class="normal">2285</span>
|
|
<span class="normal">2286</span>
|
|
<span class="normal">2287</span>
|
|
<span class="normal">2288</span>
|
|
<span class="normal">2289</span>
|
|
<span class="normal">2290</span>
|
|
<span class="normal">2291</span>
|
|
<span class="normal">2292</span>
|
|
<span class="normal">2293</span>
|
|
<span class="normal">2294</span>
|
|
<span class="normal">2295</span>
|
|
<span class="normal">2296</span>
|
|
<span class="normal">2297</span>
|
|
<span class="normal">2298</span>
|
|
<span class="normal">2299</span>
|
|
<span class="normal">2300</span>
|
|
<span class="normal">2301</span>
|
|
<span class="normal">2302</span>
|
|
<span class="normal">2303</span>
|
|
<span class="normal">2304</span>
|
|
<span class="normal">2305</span>
|
|
<span class="normal">2306</span>
|
|
<span class="normal">2307</span>
|
|
<span class="normal">2308</span>
|
|
<span class="normal">2309</span>
|
|
<span class="normal">2310</span>
|
|
<span class="normal">2311</span>
|
|
<span class="normal">2312</span>
|
|
<span class="normal">2313</span>
|
|
<span class="normal">2314</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span><span class="w"> </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="n">ClassVar</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span>
|
|
|
|
<span class="nd">@staticmethod</span>
|
|
<span class="k">def</span><span class="w"> </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_SYNCHRONOUS_DATA_PACKET</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">HCI_SynchronousDataPacket</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">if</span> <span class="n">packet_type</span> <span class="o">==</span> <span class="n">HCI_ISO_DATA_PACKET</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">HCI_IsoDataPacket</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="w"> </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="w"> </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="w"> </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="mkdocstrings-source">
|
|
<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">2329</span>
|
|
<span class="normal">2330</span>
|
|
<span class="normal">2331</span>
|
|
<span class="normal">2332</span>
|
|
<span class="normal">2333</span>
|
|
<span class="normal">2334</span>
|
|
<span class="normal">2335</span>
|
|
<span class="normal">2336</span>
|
|
<span class="normal">2337</span>
|
|
<span class="normal">2338</span>
|
|
<span class="normal">2339</span>
|
|
<span class="normal">2340</span>
|
|
<span class="normal">2341</span>
|
|
<span class="normal">2342</span>
|
|
<span class="normal">2343</span>
|
|
<span class="normal">2344</span>
|
|
<span class="normal">2345</span>
|
|
<span class="normal">2346</span>
|
|
<span class="normal">2347</span>
|
|
<span class="normal">2348</span>
|
|
<span class="normal">2349</span>
|
|
<span class="normal">2350</span>
|
|
<span class="normal">2351</span>
|
|
<span class="normal">2352</span>
|
|
<span class="normal">2353</span>
|
|
<span class="normal">2354</span>
|
|
<span class="normal">2355</span>
|
|
<span class="normal">2356</span>
|
|
<span class="normal">2357</span>
|
|
<span class="normal">2358</span>
|
|
<span class="normal">2359</span>
|
|
<span class="normal">2360</span>
|
|
<span class="normal">2361</span>
|
|
<span class="normal">2362</span>
|
|
<span class="normal">2363</span>
|
|
<span class="normal">2364</span>
|
|
<span class="normal">2365</span>
|
|
<span class="normal">2366</span>
|
|
<span class="normal">2367</span>
|
|
<span class="normal">2368</span>
|
|
<span class="normal">2369</span>
|
|
<span class="normal">2370</span>
|
|
<span class="normal">2371</span>
|
|
<span class="normal">2372</span>
|
|
<span class="normal">2373</span>
|
|
<span class="normal">2374</span>
|
|
<span class="normal">2375</span>
|
|
<span class="normal">2376</span>
|
|
<span class="normal">2377</span>
|
|
<span class="normal">2378</span>
|
|
<span class="normal">2379</span>
|
|
<span class="normal">2380</span>
|
|
<span class="normal">2381</span>
|
|
<span class="normal">2382</span>
|
|
<span class="normal">2383</span>
|
|
<span class="normal">2384</span>
|
|
<span class="normal">2385</span>
|
|
<span class="normal">2386</span>
|
|
<span class="normal">2387</span>
|
|
<span class="normal">2388</span>
|
|
<span class="normal">2389</span>
|
|
<span class="normal">2390</span>
|
|
<span class="normal">2391</span>
|
|
<span class="normal">2392</span>
|
|
<span class="normal">2393</span>
|
|
<span class="normal">2394</span>
|
|
<span class="normal">2395</span>
|
|
<span class="normal">2396</span>
|
|
<span class="normal">2397</span>
|
|
<span class="normal">2398</span>
|
|
<span class="normal">2399</span>
|
|
<span class="normal">2400</span>
|
|
<span class="normal">2401</span>
|
|
<span class="normal">2402</span>
|
|
<span class="normal">2403</span>
|
|
<span class="normal">2404</span>
|
|
<span class="normal">2405</span>
|
|
<span class="normal">2406</span>
|
|
<span class="normal">2407</span>
|
|
<span class="normal">2408</span>
|
|
<span class="normal">2409</span>
|
|
<span class="normal">2410</span>
|
|
<span class="normal">2411</span>
|
|
<span class="normal">2412</span>
|
|
<span class="normal">2413</span>
|
|
<span class="normal">2414</span>
|
|
<span class="normal">2415</span>
|
|
<span class="normal">2416</span>
|
|
<span class="normal">2417</span>
|
|
<span class="normal">2418</span>
|
|
<span class="normal">2419</span>
|
|
<span class="normal">2420</span>
|
|
<span class="normal">2421</span>
|
|
<span class="normal">2422</span>
|
|
<span class="normal">2423</span>
|
|
<span class="normal">2424</span>
|
|
<span class="normal">2425</span>
|
|
<span class="normal">2426</span>
|
|
<span class="normal">2427</span>
|
|
<span class="normal">2428</span>
|
|
<span class="normal">2429</span>
|
|
<span class="normal">2430</span>
|
|
<span class="normal">2431</span>
|
|
<span class="normal">2432</span>
|
|
<span class="normal">2433</span>
|
|
<span class="normal">2434</span>
|
|
<span class="normal">2435</span>
|
|
<span class="normal">2436</span>
|
|
<span class="normal">2437</span>
|
|
<span class="normal">2438</span>
|
|
<span class="normal">2439</span>
|
|
<span class="normal">2440</span>
|
|
<span class="normal">2441</span>
|
|
<span class="normal">2442</span>
|
|
<span class="normal">2443</span>
|
|
<span class="normal">2444</span>
|
|
<span class="normal">2445</span>
|
|
<span class="normal">2446</span>
|
|
<span class="normal">2447</span>
|
|
<span class="normal">2448</span>
|
|
<span class="normal">2449</span>
|
|
<span class="normal">2450</span>
|
|
<span class="normal">2451</span>
|
|
<span class="normal">2452</span>
|
|
<span class="normal">2453</span>
|
|
<span class="normal">2454</span>
|
|
<span class="normal">2455</span>
|
|
<span class="normal">2456</span>
|
|
<span class="normal">2457</span>
|
|
<span class="normal">2458</span>
|
|
<span class="normal">2459</span>
|
|
<span class="normal">2460</span>
|
|
<span class="normal">2461</span>
|
|
<span class="normal">2462</span>
|
|
<span class="normal">2463</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span><span class="w"> </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="nb">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="nb">dict</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">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="n">op_code</span><span class="p">:</span> <span class="nb">int</span>
|
|
<span class="n">fields</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="p">:</span> <span class="n">Fields</span> <span class="o">=</span> <span class="p">()</span>
|
|
<span class="n">_parameters</span><span class="p">:</span> <span class="nb">bytes</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span>
|
|
|
|
<span class="n">_Command</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s2">"_Command"</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="s2">"HCI_Command"</span><span class="p">)</span>
|
|
|
|
<span class="nd">@classmethod</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">command</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">subclass</span><span class="p">:</span> <span class="nb">type</span><span class="p">[</span><span class="n">_Command</span><span class="p">])</span> <span class="o">-></span> <span class="nb">type</span><span class="p">[</span><span class="n">_Command</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="c1"># Subclasses may set parameters as ClassVar, or inferred from class name.</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">subclass</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">):</span>
|
|
<span class="n">subclass</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">subclass</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="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">subclass</span><span class="p">,</span> <span class="s1">'op_code'</span><span class="p">):</span>
|
|
<span class="n">op_code</span> <span class="o">=</span> <span class="n">key_with_value</span><span class="p">(</span><span class="n">subclass</span><span class="o">.</span><span class="n">command_names</span><span class="p">,</span> <span class="n">subclass</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
|
|
<span class="k">if</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="n">subclass</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="n">subclass</span><span class="o">.</span><span class="n">op_code</span> <span class="o">=</span> <span class="n">op_code</span>
|
|
|
|
<span class="k">if</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">is_dataclass</span><span class="p">(</span><span class="n">subclass</span><span class="p">):</span>
|
|
<span class="n">subclass</span><span class="o">.</span><span class="n">fields</span> <span class="o">=</span> <span class="n">HCI_Object</span><span class="o">.</span><span class="n">fields_from_dataclass</span><span class="p">(</span><span class="n">subclass</span><span class="p">)</span>
|
|
|
|
<span class="c1"># Register a factory for this class</span>
|
|
<span class="bp">cls</span><span class="o">.</span><span class="n">command_classes</span><span class="p">[</span><span class="n">subclass</span><span class="o">.</span><span class="n">op_code</span><span class="p">]</span> <span class="o">=</span> <span class="n">subclass</span>
|
|
|
|
<span class="k">return</span> <span class="n">subclass</span>
|
|
|
|
<span class="nd">@staticmethod</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">command_map</span><span class="p">(</span><span class="n">symbols</span><span class="p">:</span> <span class="nb">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="nb">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="w"> </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="nb">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="w"> </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="n">InvalidPacketError</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">parameters</span><span class="p">,</span> <span class="n">op_code</span><span class="o">=</span><span class="n">op_code</span><span class="p">)</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="nd">@classmethod</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">from_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="nb">bytes</span><span class="p">)</span> <span class="o">-></span> <span class="n">HCI_Command</span><span class="p">:</span>
|
|
<span class="n">command</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">(</span><span class="o">**</span><span class="n">HCI_Object</span><span class="o">.</span><span class="n">dict_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">fields</span><span class="p">))</span>
|
|
<span class="n">command</span><span class="o">.</span><span class="n">parameters</span> <span class="o">=</span> <span class="n">parameters</span>
|
|
<span class="k">return</span> <span class="n">command</span>
|
|
|
|
<span class="nd">@classmethod</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">command_name</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">op_code</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">name</span> <span class="o">:=</span> <span class="bp">cls</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">return</span> <span class="n">name</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="n">subclass</span> <span class="o">:=</span> <span class="bp">cls</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="ow">and</span> <span class="n">subclass</span><span class="o">.</span><span class="n">name</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">subclass</span><span class="o">.</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="w"> </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="w"> </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="w"> </span><span class="fm">__init__</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="n">Optional</span><span class="p">[</span><span class="nb">bytes</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="o">*</span><span class="p">,</span>
|
|
<span class="n">op_code</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</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="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="c1"># op_code should be set in cls.</span>
|
|
<span class="k">if</span> <span class="n">op_code</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="n">op_code</span> <span class="o">=</span> <span class="n">op_code</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="bp">self</span><span class="o">.</span><span class="n">op_code</span><span class="p">))</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">fields</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="bp">self</span><span class="o">.</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="bp">self</span><span class="o">.</span><span class="n">fields</span><span class="p">)</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="ow">or</span> <span class="sa">b</span><span class="s1">''</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">parameters</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">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_parameters</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</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="bp">self</span><span class="o">.</span><span class="vm">__dict__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">fields</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_parameters</span>
|
|
|
|
<span class="nd">@parameters</span><span class="o">.</span><span class="n">setter</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">parameters</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="nb">bytes</span><span class="p">):</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="w"> </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="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="w"> </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="bp">self</span><span class="o">.</span><span class="n">fields</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="bp">self</span><span class="o">.</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">subclass</span><span class="p">)</span></code>
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-classmethod"><code>classmethod</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="mkdocstrings-source">
|
|
<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">2344</span>
|
|
<span class="normal">2345</span>
|
|
<span class="normal">2346</span>
|
|
<span class="normal">2347</span>
|
|
<span class="normal">2348</span>
|
|
<span class="normal">2349</span>
|
|
<span class="normal">2350</span>
|
|
<span class="normal">2351</span>
|
|
<span class="normal">2352</span>
|
|
<span class="normal">2353</span>
|
|
<span class="normal">2354</span>
|
|
<span class="normal">2355</span>
|
|
<span class="normal">2356</span>
|
|
<span class="normal">2357</span>
|
|
<span class="normal">2358</span>
|
|
<span class="normal">2359</span>
|
|
<span class="normal">2360</span>
|
|
<span class="normal">2361</span>
|
|
<span class="normal">2362</span>
|
|
<span class="normal">2363</span>
|
|
<span class="normal">2364</span>
|
|
<span class="normal">2365</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@classmethod</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">command</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">subclass</span><span class="p">:</span> <span class="nb">type</span><span class="p">[</span><span class="n">_Command</span><span class="p">])</span> <span class="o">-></span> <span class="nb">type</span><span class="p">[</span><span class="n">_Command</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="c1"># Subclasses may set parameters as ClassVar, or inferred from class name.</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">subclass</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">):</span>
|
|
<span class="n">subclass</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">subclass</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="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">subclass</span><span class="p">,</span> <span class="s1">'op_code'</span><span class="p">):</span>
|
|
<span class="n">op_code</span> <span class="o">=</span> <span class="n">key_with_value</span><span class="p">(</span><span class="n">subclass</span><span class="o">.</span><span class="n">command_names</span><span class="p">,</span> <span class="n">subclass</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
|
|
<span class="k">if</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="n">subclass</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="n">subclass</span><span class="o">.</span><span class="n">op_code</span> <span class="o">=</span> <span class="n">op_code</span>
|
|
|
|
<span class="k">if</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">is_dataclass</span><span class="p">(</span><span class="n">subclass</span><span class="p">):</span>
|
|
<span class="n">subclass</span><span class="o">.</span><span class="n">fields</span> <span class="o">=</span> <span class="n">HCI_Object</span><span class="o">.</span><span class="n">fields_from_dataclass</span><span class="p">(</span><span class="n">subclass</span><span class="p">)</span>
|
|
|
|
<span class="c1"># Register a factory for this class</span>
|
|
<span class="bp">cls</span><span class="o">.</span><span class="n">command_classes</span><span class="p">[</span><span class="n">subclass</span><span class="o">.</span><span class="n">op_code</span><span class="p">]</span> <span class="o">=</span> <span class="n">subclass</span>
|
|
|
|
<span class="k">return</span> <span class="n">subclass</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="mkdocstrings-source">
|
|
<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">2510</span>
|
|
<span class="normal">2511</span>
|
|
<span class="normal">2512</span>
|
|
<span class="normal">2513</span>
|
|
<span class="normal">2514</span>
|
|
<span class="normal">2515</span>
|
|
<span class="normal">2516</span>
|
|
<span class="normal">2517</span>
|
|
<span class="normal">2518</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="nd">@dataclasses</span><span class="o">.</span><span class="n">dataclass</span>
|
|
<span class="k">class</span><span class="w"> </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>
|
|
|
|
<span class="n">connection_handle</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">(</span><span class="mi">2</span><span class="p">))</span>
|
|
<span class="n">reason</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">(</span><span class="n">STATUS_SPEC</span><span class="p">))</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
|
|
|
|
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
|
</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="APPS & TOOLS" 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>
|
|
APPS & TOOLS
|
|
</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">{"annotate": null, "base": "..", "features": ["navigation.indexes"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "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"}, "version": null}</script>
|
|
|
|
|
|
<script src="../assets/javascripts/bundle.79ae519e.min.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |