mirror of
https://github.com/f4exb/sdrangel.git
synced 2026-06-03 06:24:48 -04:00
LoRa demod: REST API
This commit is contained in:
f4exb
@@ -45,6 +45,8 @@ ChannelSettings:
|
||||
$ref: "/doc/swagger/include/FreqTracker.yaml#/FreqTrackerSettings"
|
||||
InterferometerSettings:
|
||||
$ref: "/doc/swagger/include/Interferometer.yaml#/InterferometerSettings"
|
||||
LoRaDemodSettings:
|
||||
$ref: "/doc/swagger/include/LoRaDemod.yaml#/LoRaDemodSettings"
|
||||
LoRaModSettings:
|
||||
$ref: "/doc/swagger/include/LoRaMod.yaml#/LoRaModSettings"
|
||||
NFMDemodSettings:
|
||||
|
||||
@@ -0,0 +1,161 @@
|
||||
LoRaDemodSettings:
|
||||
description: LoRaDemod
|
||||
properties:
|
||||
inputFrequencyOffset:
|
||||
type: integer
|
||||
format: int64
|
||||
bandwidthIndex:
|
||||
type: integer
|
||||
description: >
|
||||
standard bandwidths index:
|
||||
* 0 - 2604 Hz (333333 / 128)
|
||||
* 1 - 3125 Hz (400000 / 128)
|
||||
* 2 - 3906 Hz (500000 / 128)
|
||||
* 3 - 5208 Hz (333333 / 64)
|
||||
* 4 - 6250 Hz (400000 / 64)
|
||||
* 5 - 7813 Hz (500000 / 64)
|
||||
* 6 - 10417 Hz (333333 / 32)
|
||||
* 7 - 12500 Hz (400000 / 32)
|
||||
* 8 - 15625 Hz (500000 / 32)
|
||||
* 9 - 20833 Hz (333333 / 16)
|
||||
* 10 - 25000 Hz (400000 / 16)
|
||||
* 11 - 31250 Hz (500000 / 16)
|
||||
* 12 - 41667 Hz (333333 / 8)
|
||||
* 13 - 50000 Hz (400000 / 8)
|
||||
* 14 - 62500 Hz (500000 / 8)
|
||||
* 15 - 83333 Hz (333333 / 4)
|
||||
* 16 - 100000 Hz (400000 / 4)
|
||||
* 17 - 125000 Hz (500000 / 4)
|
||||
* 18 - 166667 Hz (333333 / 2)
|
||||
* 19 - 200000 Hz (400000 / 2)
|
||||
* 20 - 250000 Hz (500000 / 2)
|
||||
* 21 - 333333 Hz (333333 / 1)
|
||||
* 22 - 400000 Hz (400000 / 1)
|
||||
* 23 - 500000 Hz (500000 / 1)
|
||||
spreadFactor:
|
||||
type: integer
|
||||
deBits:
|
||||
description: Low data rate optmize (DE) bits i.e. nb of FFT bins per effective symbol
|
||||
type: integer
|
||||
codingScheme:
|
||||
type: integer
|
||||
description: >
|
||||
message encoding scheme (LoRaModSettings::CodingScheme):
|
||||
* 0 - LoRa
|
||||
* 1 - Plain ASCII (7 bit)
|
||||
* 2 - Teletype (5 bit Baudot) a.k.a TTY
|
||||
decodeActive:
|
||||
description: boolean 1 to activate 0 to de-activate decoder
|
||||
type: integer
|
||||
eomSquelchTenths:
|
||||
description: argmax squared magnitude is compared between current multiplied by this factor and maximum during decoding. This value is divided by 10
|
||||
type: integer
|
||||
nbSymbolsMax:
|
||||
description: expected maximum number of symbols in a payload
|
||||
type: integer
|
||||
preambleChirps:
|
||||
description: Number of expected preamble chirps
|
||||
type: integer
|
||||
nbParityBits:
|
||||
description: Hamming FEC parity bits (LoRa)
|
||||
type: integer
|
||||
packetLength:
|
||||
description: expected packet length in number of bytes (LoRa)
|
||||
type: integer
|
||||
hasCRC:
|
||||
description: Payload has CRC (LoRa)
|
||||
type: integer
|
||||
hasHeader:
|
||||
description: Header present before actual payload (LoRa)
|
||||
type: integer
|
||||
rgbColor:
|
||||
type: integer
|
||||
title:
|
||||
type: string
|
||||
streamIndex:
|
||||
description: MIMO channel. Not relevant when connected to SI (single Rx).
|
||||
type: integer
|
||||
useReverseAPI:
|
||||
description: Synchronize with reverse API (1 for yes, 0 for no)
|
||||
type: integer
|
||||
reverseAPIAddress:
|
||||
type: string
|
||||
reverseAPIPort:
|
||||
type: integer
|
||||
reverseAPIDeviceIndex:
|
||||
type: integer
|
||||
reverseAPIChannelIndex:
|
||||
type: integer
|
||||
|
||||
LoRaDemodReport:
|
||||
description: LoRaDemod
|
||||
properties:
|
||||
channelPowerDB:
|
||||
description: current de-chirped total channel power (dB)
|
||||
type: number
|
||||
format: float
|
||||
noisePowerDB:
|
||||
description: current de-chirped noise argmax power (dB)
|
||||
type: number
|
||||
format: float
|
||||
signalPowerDB:
|
||||
description: last message de-chirped signal argmax power (dB)
|
||||
type: number
|
||||
format: float
|
||||
snrPowerDB:
|
||||
description: last message de-chirped signal to noise ratio power (dB)
|
||||
type: number
|
||||
format: float
|
||||
channelSampleRate:
|
||||
type: integer
|
||||
syncWord:
|
||||
description: 2 bytes sync word (0..65535)
|
||||
type: integer
|
||||
hasCRC:
|
||||
description: boolean 1 if payload CRC is present else 0 (LoRa)
|
||||
type: integer
|
||||
nbParityBits:
|
||||
description: Hamming FEC parity bits (LoRa)
|
||||
type: integer
|
||||
packetLength:
|
||||
description: Packet length in number of bytes (LoRa)
|
||||
type: integer
|
||||
nbSymbols:
|
||||
description: Number of symbols in the payload with header and CRC (LoRa)
|
||||
type: integer
|
||||
nbCodewords:
|
||||
description: Number of codewords in the payload with header and CRC (LoRa)
|
||||
type: integer
|
||||
headerParityStatus:
|
||||
type: integer
|
||||
description: >
|
||||
Header FEC parity status:
|
||||
* 0 - Undefined
|
||||
* 1 - Uncorrectable error
|
||||
* 2 - Corrected error
|
||||
* 3 - OK
|
||||
headerCRCStatus:
|
||||
description: header CRC check status. Boolean 1 if OK else 0
|
||||
type: integer
|
||||
payloadParityStatus:
|
||||
type: integer
|
||||
description: >
|
||||
Payload FEC parity status:
|
||||
* 0 - Undefined
|
||||
* 1 - Uncorrectable error
|
||||
* 2 - Corrected error
|
||||
* 3 - OK
|
||||
payloadCRCStatus:
|
||||
description: payload CRC check status. Boolean 1 if OK else 0
|
||||
type: integer
|
||||
messageTimestamp:
|
||||
description: timestamp of the last decoded message
|
||||
type: string
|
||||
messageString:
|
||||
description: string representation of the last decoded message
|
||||
type: string
|
||||
messageBytes:
|
||||
description: bytes of the last decoded message as an array of hex string represented bytes (00..FF)
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
@@ -6,6 +6,32 @@ LoRaModSettings:
|
||||
format: int64
|
||||
bandwidthIndex:
|
||||
type: integer
|
||||
description: >
|
||||
standard bandwidths index:
|
||||
* 0 - 2604 Hz (333333 / 128)
|
||||
* 1 - 3125 Hz (400000 / 128)
|
||||
* 2 - 3906 Hz (500000 / 128)
|
||||
* 3 - 5208 Hz (333333 / 64)
|
||||
* 4 - 6250 Hz (400000 / 64)
|
||||
* 5 - 7813 Hz (500000 / 64)
|
||||
* 6 - 10417 Hz (333333 / 32)
|
||||
* 7 - 12500 Hz (400000 / 32)
|
||||
* 8 - 15625 Hz (500000 / 32)
|
||||
* 9 - 20833 Hz (333333 / 16)
|
||||
* 10 - 25000 Hz (400000 / 16)
|
||||
* 11 - 31250 Hz (500000 / 16)
|
||||
* 12 - 41667 Hz (333333 / 8)
|
||||
* 13 - 50000 Hz (400000 / 8)
|
||||
* 14 - 62500 Hz (500000 / 8)
|
||||
* 15 - 83333 Hz (333333 / 4)
|
||||
* 16 - 100000 Hz (400000 / 4)
|
||||
* 17 - 125000 Hz (500000 / 4)
|
||||
* 18 - 166667 Hz (333333 / 2)
|
||||
* 19 - 200000 Hz (400000 / 2)
|
||||
* 20 - 250000 Hz (500000 / 2)
|
||||
* 21 - 333333 Hz (333333 / 1)
|
||||
* 22 - 400000 Hz (400000 / 1)
|
||||
* 23 - 500000 Hz (500000 / 1)
|
||||
spreadFactor:
|
||||
type: integer
|
||||
deBits:
|
||||
@@ -55,16 +81,16 @@ LoRaModSettings:
|
||||
type: integer
|
||||
description: >
|
||||
type of message to send (LoRaModSettings::MessageType):
|
||||
* 0 - No message i.e no output. Use this as a transition to resend the same message.
|
||||
* 1 - Beacon. Sends message specified in beaconMessage
|
||||
* 2 - CQ call. Sends message specified in cqMessage
|
||||
* 3 - Reply to CQ call. Sends message specified in replyMessage
|
||||
* 4 - Report to callee. Sends message specified in reportMessage
|
||||
* 5 - Report to caller. Sends message specified in replyReportMessage
|
||||
* 6 - RRR to callee. Sends message specified in rrrMessage
|
||||
* 7 - 73 to caller. Sends message specified in message73
|
||||
* 8 - Random message with callsigns. Sends message specified in qsoTextMessage
|
||||
* 9 - Plain text. Sends message specified in textMessage
|
||||
* 0 - No message i.e no output. Use this as a transition to resend the same message.
|
||||
* 1 - Beacon. Sends message specified in beaconMessage
|
||||
* 2 - CQ call. Sends message specified in cqMessage
|
||||
* 3 - Reply to CQ call. Sends message specified in replyMessage
|
||||
* 4 - Report to callee. Sends message specified in reportMessage
|
||||
* 5 - Report to caller. Sends message specified in replyReportMessage
|
||||
* 6 - RRR to callee. Sends message specified in rrrMessage
|
||||
* 7 - 73 to caller. Sends message specified in message73
|
||||
* 8 - Random message with callsigns. Sends message specified in qsoTextMessage
|
||||
* 9 - Plain text. Sends message specified in textMessage
|
||||
* 10 - Binary payload. Sends bytes specified in bytesMessage
|
||||
beaconMessage:
|
||||
description: text message to be sent (repeatedly) as a beaconMessage
|
||||
@@ -94,10 +120,10 @@ LoRaModSettings:
|
||||
description: freeform text message
|
||||
type: string
|
||||
bytesMessage:
|
||||
description: message to send as an array of hex string represented bytes (00..FF)
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description: message to send as an array of hex string represented bytes (00..FF)
|
||||
messageRepeat:
|
||||
description: number of repetitions of the same message (0 for infinite)
|
||||
type: integer
|
||||
|
||||
Reference in New Issue
Block a user