Sections de la documentation

Calculateur de bilan de liaison et de portée BLE — Bluetooth Low Energy par PHY

POSThttps://rftools.io/api/py/v1/calculate

Slug ble-link-budget. Bilan de liaison Bluetooth Low Energy par PHY : débit et sensibilité de récepteur de la Core Specification pour LE 1M, LE 2M et LE Coded, affaiblissement de propagation en espace libre ou selon le modèle intérieur ITU-R P.1238, puissance reçue, marge de liaison et portée maximale.

Entrées

Envoyez chacune de ces entrées dans inputs, dans les unités indiquées. La plupart sont obligatoires : un appel auquel il en manque une est refusé (400) et ne coûte rien ; une entrée dont le calculateur peut se passer prend la valeur par défaut indiquée. Une entrée hors de sa plage est tout de même calculée et signalée dans la provenance.

Entrées de ble-link-budget
Nom	Unité	Plage	Valeur par défaut	Description
phynombre	aucune	0 … 3	0	Couche physique Bluetooth LE : 1M (1 Mb/s), 2M (2 Mb/s) ou PHY codé à 500 kb/s (S=2) ou 125 kb/s (S=8)
txPowernombre	dBm	quelconque	0	La Core Specification autorise de −20 à +20 dBm
txGainnombre	dBi	quelconque	0	Gain de l'antenne d'émission
rxGainnombre	dBi	quelconque	0	Gain de l'antenne de réception
lossesnombre	dB	au moins 0	0	Pertes corps, boîtier et autres
frequencynombre	MHz	au moins 1	2440	Les canaux LE vont de 2402 à 2480 MHz ; 2440 MHz est au milieu de la bande
pathLossModelnombre	aucune	0 … 8	2	Espace libre, ou modèle général de l'ITU-R P.1238 pour un bureau, un couloir, un site industriel ou une salle de conférence, en visibilité directe (LoS) ou non (NLoS)L'une de : 0 Espace libre · 1 P.1238 bureau LoS · 2 P.1238 bureau NLoS · 3 P.1238 couloir LoS · 4 P.1238 couloir NLoS · 5 P.1238 industriel LoS · 6 P.1238 industriel NLoS · 7 P.1238 salle de conférence LoS · 8 P.1238 salle de conférence NLoS
distancenombre	m	au moins 0.01	10	Distance directe (3-D) entre les antennes
sensitivityOverridenombre	dBm	au plus 0	0	Saisissez la sensibilité de la fiche technique de la radio pour remplacer la référence de la Core Specification ; 0 conserve la référence
extraLossCountnombre	aucune	0 … 6	0	Nombre de pertes supplémentaires sur le lien, par exemple l'entrée dans un bâtiment, la végétation, le corps ou un désaccord de polarisation (0–6)
extraLoss1nombre	dB	0 … 50	0	Une perte supplémentaire sur le lien, par exemple l'entrée dans un bâtiment, la végétation, l'absorption par le corps ou un désaccord de polarisation
extraLoss2nombre	dB	0 … 50	0	Une perte supplémentaire sur le lien, par exemple l'entrée dans un bâtiment, la végétation, l'absorption par le corps ou un désaccord de polarisation
extraLoss3nombre	dB	0 … 50	0	Une perte supplémentaire sur le lien, par exemple l'entrée dans un bâtiment, la végétation, l'absorption par le corps ou un désaccord de polarisation
extraLoss4nombre	dB	0 … 50	0	Une perte supplémentaire sur le lien, par exemple l'entrée dans un bâtiment, la végétation, l'absorption par le corps ou un désaccord de polarisation
extraLoss5nombre	dB	0 … 50	0	Une perte supplémentaire sur le lien, par exemple l'entrée dans un bâtiment, la végétation, l'absorption par le corps ou un désaccord de polarisation
extraLoss6nombre	dB	0 … 50	0	Une perte supplémentaire sur le lien, par exemple l'entrée dans un bâtiment, la végétation, l'absorption par le corps ou un désaccord de polarisation

Sorties

Renvoyées dans values, par nom. Une valeur non bornée ou non définie vaut null.

Sorties de ble-link-budget
Champ	Unité	Description
linkMarginprincipale	dB	Marge de liaison
dataRate	Mb/s	Débit du PHY
sensitivityUsed	dBm	Sensibilité du récepteur utilisée
pathLoss	dB	Affaiblissement de propagation
receivedPower	dBm	Puissance reçue
maxRange	m	Portée maximale
shadowFadingStd	dB	Écart type de l'effet de masque (σ de P.1238)
totalLoss	dB	Perte totale

Comment l'appeler

Calculer : un appel, la requête et la réponse complètes, et ses erreurs.
Calcul par lots : ce calculateur avec d'autres, ou un balayage, en une seule requête.
Résoudre pour une valeur cible : la valeur d'une entrée qui amène une sortie à une cible.

curl -X POST https://rftools.io/api/py/v1/calculate \
  -H "X-API-Key: $RFTOOLS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "ble-link-budget",
    "inputs": {
      "phy": 0,
      "txPower": 0,
      "txGain": 0,
      "rxGain": 0,
      "losses": 0,
      "frequency": 2440,
      "pathLossModel": 2,
      "distance": 10,
      "sensitivityOverride": 0,
      "extraLossCount": 0,
      "extraLoss1": 0,
      "extraLoss2": 0,
      "extraLoss3": 0,
      "extraLoss4": 0,
      "extraLoss5": 0,
      "extraLoss6": 0
    }
  }'

import rftools

client = rftools.Client()  # reads RFTOOLS_API_KEY, or the key `rftools login` saved

result = client.calculate("ble-link-budget", {
    "phy": 0,
    "txPower": 0,
    "txGain": 0,
    "rxGain": 0,
    "losses": 0,
    "frequency": 2440,
    "pathLossModel": 2,
    "distance": 10,
    "sensitivityOverride": 0,
    "extraLossCount": 0,
    "extraLoss1": 0,
    "extraLoss2": 0,
    "extraLoss3": 0,
    "extraLoss4": 0,
    "extraLoss5": 0,
    "extraLoss6": 0,
})
print(result.values)
print(result.warnings, result.provenance.formula_ref)

const response = await fetch("https://rftools.io/api/py/v1/calculate", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.RFTOOLS_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "slug": "ble-link-budget",
    "inputs": {
      "phy": 0,
      "txPower": 0,
      "txGain": 0,
      "rxGain": 0,
      "losses": 0,
      "frequency": 2440,
      "pathLossModel": 2,
      "distance": 10,
      "sensitivityOverride": 0,
      "extraLossCount": 0,
      "extraLoss1": 0,
      "extraLoss2": 0,
      "extraLoss3": 0,
      "extraLoss4": 0,
      "extraLoss5": 0,
      "extraLoss6": 0
    }
  }),
});
console.log(response.status, await response.json());

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{
	  "slug": "ble-link-budget",
	  "inputs": {
	    "phy": 0,
	    "txPower": 0,
	    "txGain": 0,
	    "rxGain": 0,
	    "losses": 0,
	    "frequency": 2440,
	    "pathLossModel": 2,
	    "distance": 10,
	    "sensitivityOverride": 0,
	    "extraLossCount": 0,
	    "extraLoss1": 0,
	    "extraLoss2": 0,
	    "extraLoss3": 0,
	    "extraLoss4": 0,
	    "extraLoss5": 0,
	    "extraLoss6": 0
	  }
	}`)
	req, err := http.NewRequest("POST", "https://rftools.io/api/py/v1/calculate", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("RFTOOLS_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.Status, string(out))
}

application/json

{
  "slug": "ble-link-budget",
  "values": {
    "linkMargin": 6.672644167870494,
    "dataRate": 1,
    "sensitivityUsed": -70,
    "pathLoss": 63.327355832129506,
    "receivedPower": -63.327355832129506,
    "maxRange": 19.01910747302111,
    "shadowFadingStd": 5.01,
    "totalLoss": 63.327355832129506
  },
  "warnings": [],
  "errors": [],
  "provenance": {
    "method": "calculator:ble-link-budget",
    "version": "api@3f2c1a9b04de",
    "formulaRef": "Bluetooth Core Specification v5.4, Vol 6, Part A, §1–§4; ITU-R P.1238-13, §3.1, Table 2; ITU-R P.525-4, Eq. (3)",
    "assumptions": [
      {
        "code": "core-spec-sensitivity",
        "text": "Unless a datasheet value is entered, the receiver sensitivity is the Core Specification requirement for the PHY, the worst a compliant receiver may have; real radios are often 20 dB or more better."
      },
      {
        "code": "median-path-loss",
        "text": "Path loss is the free-space value or the ITU-R P.1238 site-general median for the environment, with no fade margin; the link margin is what is left for fading."
      }
    ],
    "validRange": {
      "status": "inside",
      "bounds": {
        "phy": {
          "min": 0,
          "max": 3,
          "unit": ""
        },
        "txPower": {
          "min": null,
          "max": null,
          "unit": "dBm"
        },
        "txGain": {
          "min": null,
          "max": null,
          "unit": "dBi"
        },
        "rxGain": {
          "min": null,
          "max": null,
          "unit": "dBi"
        },
        "losses": {
          "min": 0,
          "max": null,
          "unit": "dB"
        },
        "frequency": {
          "min": 1,
          "max": null,
          "unit": "MHz"
        },
        "pathLossModel": {
          "min": 0,
          "max": 8,
          "unit": ""
        },
        "distance": {
          "min": 0.01,
          "max": null,
          "unit": "m"
        },
        "sensitivityOverride": {
          "min": null,
          "max": 0,
          "unit": "dBm"
        },
        "extraLossCount": {
          "min": 0,
          "max": 6,
          "unit": ""
        },
        "extraLoss1": {
          "min": 0,
          "max": 50,
          "unit": "dB"
        },
        "extraLoss2": {
          "min": 0,
          "max": 50,
          "unit": "dB"
        },
        "extraLoss3": {
          "min": 0,
          "max": 50,
          "unit": "dB"
        },
        "extraLoss4": {
          "min": 0,
          "max": 50,
          "unit": "dB"
        },
        "extraLoss5": {
          "min": 0,
          "max": 50,
          "unit": "dB"
        },
        "extraLoss6": {
          "min": 0,
          "max": 50,
          "unit": "dB"
        }
      },
      "outside": [],
      "model": null
    },
    "computedAt": "2026-09-24T14:05:11.003Z",
    "inputs": {
      "phy": 0,
      "txPower": 0,
      "txGain": 0,
      "rxGain": 0,
      "losses": 0,
      "frequency": 2440,
      "pathLossModel": 2,
      "distance": 10,
      "sensitivityOverride": 0,
      "extraLossCount": 0,
      "extraLoss1": 0,
      "extraLoss2": 0,
      "extraLoss3": 0,
      "extraLoss4": 0,
      "extraLoss5": 0,
      "extraLoss6": 0
    },
    "seed": null,
    "elapsedSeconds": 0.003
  }
}

{
  "detail": [
    {
      "type": "float_parsing",
      "loc": [
        "body",
        "inputs",
        "phy"
      ],
      "msg": "Input should be a valid number, unable to parse string as a number",
      "input": "abc"
    }
  ]
}

Une entrée envoyée sous forme de texte. Rien n'a été décompté.

{
  "detail": "More than 120 requests in 60 seconds from this address.",
  "errorKind": "rate_limited",
  "limit": 120,
  "windowSeconds": 60,
  "upgradeUrl": "https://rftools.io/pricing/"
}

Trop de requêtes en une minute, avec Retry-After.

Les mêmes entrées sur la page du calculateurCalculateur de bilan de liaison et de portée BLE — Bluetooth Low Energy par PHY, avec ces valeurs