Skip to content
ドキュメントのセクション

計算

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

255 種の計算ツールのいずれかを、そのページで入力するのと同じ値で、ページに表示される単位で実行し、すべての出力、警告、来歴を JSON で返します。

X-API-Key ヘッダーで認証します。キーは rfc_ で始まり、ダッシュボードで作成します。すべての呼び出しは、アカウントの月間利用枠に計上されます:Free で 5 回, Pro で 100 回, API で 10,000 回。

リクエストボディ

CalculateRequest
フィールド説明
slug必須string計算ツール。ページのアドレスにあるスラッグで指定します(例:rf-link-budget)。すべてのスラッグは「スラッグと入力」に載っています。
inputs必須object of numbers入力値。計算ツールの入力キーごとに、リファレンスに載っている単位で指定します。入力はすべて送信してください。ほとんどは必須で、1 つでも欠けた呼び出しは拒否されます(400)。省略された任意の入力は、リファレンスに示された既定値を使います。計算ツールが読み取らないキーは、警告付きで無視されます。

rf-link-budget の入力

計算ツールの定義から生成しています。範囲外の入力も計算され、来歴で示されます。すべての計算ツールの入力はスラッグと入力にあります。

rf-link-budget の入力
名前単位範囲既定値説明
txPower数値dBm−30 … 10030トランスミッタ出力パワー
txGain数値dBi−30 … 603TX アンテナゲイン (dBi)
txCableLoss数値dB0 … 201TX ケーブル + コネクタ損失 (正の値)
frequency数値MHz0.1 … 10000002400中心周波数
distance数値km0.001 … 10000001TX と RX の間の距離
rainFade数値dB0 … 500ITU-R P.838に準拠した雨量減衰量見通し内の接地リンクには 0 を、豪雨地帯で 10 GHz を超える衛星リンクには 3 ~ 20 dB を使用します。
atmosphericLoss数値dB0 … 200.5ガス吸収(60 GHzでのO₂:約15 dB/km、22 GHzでのH₂O:約0.2 dB/km)。6 GHz 以下の地上波リンクには 0.5 dB(標準)を使用してください。
pointingLoss数値dB0 … 100アンテナのミスアライメント損失。ペンシルビームディッシュ:0.5~3 dB全方向性アンテナまたはワイドビームアンテナ:0 dB
extraLossCount数値なし0 … 40偏光ミスマッチ、ボディロス、フォリッジなど、予算に含まれる追加損失条件の数
extraLoss1数値dB0 … 500偏光ミスマッチ、ボディロス、葉や壁など、経路上の余分な損失
extraLoss2数値dB0 … 500偏光ミスマッチ、ボディロス、葉や壁など、経路上の余分な損失
extraLoss3数値dB0 … 500偏光ミスマッチ、ボディロス、葉や壁など、経路上の余分な損失
extraLoss4数値dB0 … 500偏光ミスマッチ、ボディロス、葉や壁など、経路上の余分な損失
rxGain数値dBi−30 … 603RX アンテナゲイン (dBi)
rxCableLoss数値dB0 … 201RX ケーブル + コネクタロス
rxSensitivity数値dBm−160 … 0-90最小受信信号レベル
targetMargin数値dB0 … 6010リンクのフェードマージンは、レシーバーの感度以上に保つ必要があります。ステータスはそれ以上で合格し、0 dB 未満ではフェイルします。

レスポンス

CalculateResponse
フィールド説明
slugstring要求された計算ツール。
valuesobject of numbers各出力をキーごとに、リファレンスに載っている単位で返します。値に上限がない場合や定義されない場合(完全整合時のリターンロスなど)は null です。
warningsstring[]計算ツール自身の警告と、その後に API の警告:読み取られなかった入力、計算ツールの対象範囲外の入力。
errorsstring[]計算ツールのエラー。成功時は空です。
provenanceobject値の計算方法:手法、エンジンのバージョン、式の出典、前提、有効範囲。「来歴」をご覧ください。

rf-link-budget の出力(values 内):

rf-link-budget の出力
フィールド単位説明
fspldBフリースペースパスロス
eirpdBmEIRP
rxPowerdBm受信電力
linkMargin主要値dBリンクマージン
maxRangeKmkm最大範囲
totalAdditionalLossdB追加損失合計
maxRangeAtTargetkmターゲットマージンでの範囲
wavelengthmm波長
fresnelRadiusm最初のフレネルゾーン半径

エラー

POST /calculate のエラー
ステータスPython の例外発生する場合
400ValidationError送られたままではリクエストに答えられません:有限の数でない入力、設定できない逆算、契約外のジョブのボディ、空または上限を超えたバッチ。計上はされません。
401AuthErrorキーが送信されていない(ボディに keyUrl が入ります)か、こちらで発行していないキーや失効したキーです。利用枠とは関係ありません。
402QuotaError計上対象のすべてのルートで、アカウントの月間利用枠を使い切りました。計上はされていません。Retry-After に resetAt までの秒数が入ります。
404NotFoundそのような計算ツールのスラッグ、ジョブタイプ、ジョブは存在しません。計上はされません。
422ValidationErrorボディを解析できません:必須フィールドが欠けているか、値の型が違います(テキストとして送られた入力など)。ルートの実行前に応答します。
429RateLimitErrorその認証情報で 1 分あたりのリクエストが多すぎるか、キュー待ち・実行中のジョブが同時に多すぎます。Retry-After に再試行できる時期が示されます。
500APIError結果は計算されましたが返せなかったか、逆算に失敗しました。課金はされていません。
503APIErrorキーまたは利用枠のカウンターを確認できなかったか、ジョブをキューに入れられませんでした。キューにも入っておらず、課金もされていません。もう一度お試しください。

キー、計算ツール、入力の順にすべてのチェックが行われ、その前に計上されることはありません。各ボディはエラーをご覧ください。

試してみる

ご自身のキーで、このページからリクエストを送信します。ほかの呼び出しと同じく計上されます。

リクエストにはキーが必要で、そのアカウントの利用枠に計上されます。無料のキーを取得してください。