Sections de la documentation

Portée du capteur de proximité optique

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

Slug optical-sensor-range. Comparez les configurations des capteurs de proximité optiques par facteur de détection. Analysez la puissance de l'émetteur, la réactivité du détecteur et les compromis en termes de réflectivité.

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 optical-sensor-range
Nom	Unité	Plage	Valeur par défaut	Description
emitterPowernombre	mW	au moins 0.001	10	Puissance de l'émetteur
detectorSensitivitynombre	A/W	au moins 0.001	0.6	Photodiode au silicium typique : 0,5 à 0,8 A/W à 850 nm
targetReflectivitynombre	%	0.1 … 100	90	Réflectivité de la cible
safetyFactornombre	aucune	au moins 1	1.5	Facteur de sécurité

Sorties

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

Sorties de optical-sensor-range
Champ	Unité	Description
maxRangeprincipale	aucune	Facteur de détection relatif
normalizedRange	aucune	Facteur de détection nominal

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": "optical-sensor-range",
    "inputs": {
      "emitterPower": 10,
      "detectorSensitivity": 0.6,
      "targetReflectivity": 90,
      "safetyFactor": 1.5
    }
  }'

import rftools

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

result = client.calculate("optical-sensor-range", {
    "emitterPower": 10,
    "detectorSensitivity": 0.6,
    "targetReflectivity": 90,
    "safetyFactor": 1.5,
})
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": "optical-sensor-range",
    "inputs": {
      "emitterPower": 10,
      "detectorSensitivity": 0.6,
      "targetReflectivity": 90,
      "safetyFactor": 1.5
    }
  }),
});
console.log(response.status, await response.json());

package main

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

func main() {
	body := []byte(`{
	  "slug": "optical-sensor-range",
	  "inputs": {
	    "emitterPower": 10,
	    "detectorSensitivity": 0.6,
	    "targetReflectivity": 90,
	    "safetyFactor": 1.5
	  }
	}`)
	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": "optical-sensor-range",
  "values": {
    "maxRange": 1.5491933384829668,
    "normalizedRange": 2.32379000772445
  },
  "warnings": [],
  "errors": [],
  "provenance": {
    "method": "calculator:optical-sensor-range",
    "version": "api@3f2c1a9b04de",
    "formulaRef": null,
    "assumptions": [],
    "validRange": {
      "status": "inside",
      "bounds": {
        "emitterPower": {
          "min": 0.001,
          "max": null,
          "unit": "mW"
        },
        "detectorSensitivity": {
          "min": 0.001,
          "max": null,
          "unit": "A/W"
        },
        "targetReflectivity": {
          "min": 0.1,
          "max": 100,
          "unit": "%"
        },
        "safetyFactor": {
          "min": 1,
          "max": null,
          "unit": ""
        }
      },
      "outside": [],
      "model": null
    },
    "computedAt": "2026-09-24T14:05:11.003Z",
    "inputs": {
      "emitterPower": 10,
      "detectorSensitivity": 0.6,
      "targetReflectivity": 90,
      "safetyFactor": 1.5
    },
    "seed": null,
    "elapsedSeconds": 0.003
  }
}

{
  "detail": [
    {
      "type": "float_parsing",
      "loc": [
        "body",
        "inputs",
        "emitterPower"
      ],
      "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 calculateurPortée du capteur de proximité optique, avec ces valeurs