Secciones de la documentación
Calcular
Ejecuta cualquiera de las 255 calculadoras con las entradas que escribiría en su página, en las unidades que muestra la página, y devuelve cada salida, las advertencias y la procedencia en JSON.
Autentíquese con la cabecera X-API-Key. Las claves empiezan por rfc_ y se crean en el panel. Cada llamada se descuenta de la cuota mensual de la cuenta: 5 con Free, 100 con Pro, 10.000 con API.
Cuerpo de la solicitud
| Campo | Descripción |
|---|---|
| slugobligatoriostring | La calculadora, por el slug de la dirección de su página, p. ej. rf-link-budget. Todos los slugs figuran en «Slugs y entradas». |
| inputsobligatorioobject of numbers | Valores de entrada con las claves de entrada de la calculadora, en las unidades que indica su referencia. Envíe todas las entradas: la mayoría son obligatorias, y una llamada a la que le falte una se rechaza (400); una opcional omitida toma el valor predeterminado que muestra la referencia. Una clave que la calculadora no lee se ignora con una advertencia. |
Entradas de rf-link-budget
Generadas a partir de la definición de la calculadora. Una entrada fuera de su rango se calcula igualmente y se marca en la procedencia. Las entradas de cada calculadora están en Slugs y entradas.
| Nombre | Unidad | Rango | Valor predeterminado | Descripción |
|---|---|---|---|---|
| txPowernúmero | dBm | −30 … 100 | 30 | Potencia de salida del transmisor |
| txGainnúmero | dBi | −30 … 60 | 3 | Ganancia de antena TX en dBi |
| txCableLossnúmero | dB | 0 … 20 | 1 | Pérdidas en el conector del cable TX + (valor positivo) |
| frequencynúmero | MHz | 0.1 … 1000000 | 2400 | Frecuencia central |
| distancenúmero | km | 0.001 … 1000000 | 1 | Distancia entre TX y RX |
| rainFadenúmero | dB | 0 … 50 | 0 | Atenuación por lluvia según ITU-R P.838. Utilice 0 para los enlaces terrestres con línea de visión; de 3 a 20 dB para los enlaces por satélite de más de 10 GHz en zonas de fuertes lluvias. |
| atmosphericLossnúmero | dB | 0 … 20 | 0.5 | Absorción gaseosa (O₂ a 60 GHz: ~15 dB/km; H₂O a 22 GHz: ~0,2 dB/km). Utilice 0,5 dB típicos para enlaces terrestres de menos de 6 GHz. |
| pointingLossnúmero | dB | 0 … 10 | 0 | Pérdida de desalineación de la antena. Antenas con forma de lápiz: 0,5 — 3 dB. Antenas omnidireccionales o de haz ancho: 0 dB. |
| extraLossCountnúmero | ninguna | 0 … 4 | 0 | Cuántas condiciones de pérdida adicionales incluye el presupuesto, como el desajuste de la polarización, la pérdida de cuerpo o el follaje |
| extraLoss1número | dB | 0 … 50 | 0 | Una pérdida adicional en el camino, como un desajuste de la polarización, la pérdida de cuerpo, el follaje o una pared |
| extraLoss2número | dB | 0 … 50 | 0 | Una pérdida adicional en el camino, como un desajuste de la polarización, la pérdida de cuerpo, el follaje o una pared |
| extraLoss3número | dB | 0 … 50 | 0 | Una pérdida adicional en el camino, como un desajuste de la polarización, la pérdida de cuerpo, el follaje o una pared |
| extraLoss4número | dB | 0 … 50 | 0 | Una pérdida adicional en el camino, como un desajuste de la polarización, la pérdida de cuerpo, el follaje o una pared |
| rxGainnúmero | dBi | −30 … 60 | 3 | Ganancia de antena RX en dBi |
| rxCableLossnúmero | dB | 0 … 20 | 1 | Pérdidas en el conector del cable RX + |
| rxSensitivitynúmero | dBm | −160 … 0 | -90 | Nivel mínimo de señal a recibir |
| targetMarginnúmero | dB | 0 … 60 | 10 | El margen de atenuación que el enlace debe mantener por encima de la sensibilidad del receptor. El estado pasa a un valor igual o superior y falla por debajo de 0 dB. |
Respuesta
| Campo | Descripción |
|---|---|
| slugstring | La calculadora, tal como se pidió. |
| valuesobject of numbers | Cada salida por su clave, en las unidades que indica su referencia. null cuando un valor es ilimitado o no está definido, como la pérdida de retorno de una adaptación perfecta. |
| warningsstring[] | Las advertencias propias de la calculadora y luego las de la API: una entrada no leída, una entrada fuera del rango para el que está indicada la calculadora. |
| errorsstring[] | Los errores de la calculadora; vacío si todo fue bien. |
| provenanceobject | Cómo se calcularon los valores: método, versión del motor, referencia de la fórmula, supuestos y rango válido. Consulte Procedencia. |
Las salidas de rf-link-budget, en values:
| Campo | Unidad | Descripción |
|---|---|---|
| fspl | dB | Pérdida de trayectoria en el espacio libre |
| eirp | dBm | EIRP |
| rxPower | dBm | Potencia recibida |
| linkMarginprincipal | dB | Margen de enlace |
| maxRangeKm | km | Alcance máximo |
| totalAdditionalLoss | dB | Pérdida adicional total |
| maxRangeAtTarget | km | Alcance en el margen objetivo |
| wavelength | mm | Longitud de onda |
| fresnelRadius | m | Primer radio de la zona de Fresnel |
Errores
| Estado | Excepción de Python | Cuándo |
|---|---|---|
| 400 | ValidationError | La solicitud no puede responderse tal como se envió: una entrada que no es un número finito, una resolución que no puede plantearse, un cuerpo de trabajo fuera de su contrato o un lote vacío o por encima de su límite. No se cuenta nada. |
| 401 | AuthError | No se envió ninguna clave (el cuerpo lleva keyUrl), o la clave no la emitimos nosotros o fue revocada. Nunca se refiere a la cuota. |
| 402 | QuotaError | La cuota mensual de la cuenta está agotada, en todas las rutas contabilizadas. No se contó nada. Retry-After da los segundos hasta resetAt. |
| 404 | NotFound | No existe ese slug de calculadora, tipo de trabajo o trabajo. No se cuenta nada. |
| 422 | ValidationError | El cuerpo no se puede leer: falta un campo obligatorio, o un valor es de un tipo incorrecto (una entrada enviada como texto). Se responde antes de que se ejecute la ruta. |
| 429 | RateLimitError | Demasiadas solicitudes en un minuto para la credencial, o demasiados trabajos en cola o en ejecución a la vez. Retry-After indica cuándo volver a intentarlo. |
| 500 | APIError | El resultado se calculó pero no se pudo devolver, o falló una resolución. No se cobró nada. |
| 503 | APIError | No se pudo comprobar la clave ni el contador de la cuota, o no se pudo poner en cola un trabajo. No se puso nada en cola ni se cobró nada; inténtelo de nuevo. |
Todas las comprobaciones se hacen antes de contar nada: la clave, la calculadora y luego las entradas. Consulte Errores para cada cuerpo.
Pruébelo
Envíe una solicitud desde esta página con su propia clave. Cuenta como cualquier otra llamada.
Una solicitud necesita una clave y se descuenta de la cuota de su cuenta. Obtenga una clave gratuita.