VE7UWU/sdrangel
1
0
Fork 0
mirror of https://github.com/f4exb/sdrangel.git synced 2026-07-17 16:24:08 -04:00
Code Issues Projects Releases Wiki Activity

LoRa modulator: REST API (1)

Browse Source
This commit is contained in:
f4exb
2020-02-22 18:37:09 +01:00
parent 738f671255
commit 9aaa4756a2
17 changed files with 1568 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
sdrbase/resources/webapi/doc/html2/index.html
+112 -4
View File
@@ -4389,6 +4389,21 @@ margin-bottom: 20px;
},
"channelSampleRate" : {
"type" : "integer"
},
"symbolTimeMs" : {
"type" : "number",
"format" : "float",
"description" : "symbol duration (ms)"
},
"payloadTimeMs" : {
"type" : "number",
"format" : "float",
"description" : "payload duration (ms)"
},
"totalTimeMs" : {
"type" : "number",
"format" : "float",
"description" : "total message duration inc. preamble and SFD (ms)"
}
},
"description" : "LoRaMod"
@@ -4406,15 +4421,108 @@ margin-bottom: 20px;
"type" : "integer"
},
"deBits" : {
"type" : "integer"
"type" : "integer",
"description" : "Low data rate optmize (DE) bits i.e. nb of FFT bins per effective symbol"
},
"message" : {
"type" : "string"
"preambleChirps" : {
"type" : "integer",
"description" : "Number of preamble chirps"
},
"quietMillis" : {
"type" : "integer",
"description" : "Number of milliseconds to pause between transmissions"
},
"syncWord" : {
"type" : "integer",
"description" : "2 byte (0..65535) synchronization syncWord"
},
"channelMute" : {
"type" : "integer",
"description" : "boolean"
},
"codingScheme" : {
"type" : "integer",
"description" : "message encoding scheme (LoRaModSettings::CodingScheme):\n * 0 - LoRa\n * 1 - Plain ASCII (7 bit)\n * 2 - Teletype (5 bit Baudot) a.k.a TTY\n"
},
"nbParityBits" : {
"type" : "integer",
"description" : "Hamming FEC parity bits (LoRa)"
},
"hasCRC" : {
"type" : "integer",
"description" : "Payload has CRC (LoRa)"
},
"hasHeader" : {
"type" : "integer",
"description" : "Header present before actual payload (LoRa)"
},
"myCall" : {
"type" : "string",
"description" : "own callsign placeholder (QSO mode)"
},
"urCall" : {
"type" : "string",
"description" : "other party callsign placeholder (QSO mode)"
},
"myLoc" : {
"type" : "string",
"description" : "own QRA locator (QSO mode)"
},
"myRpt" : {
"type" : "string",
"description" : "report sent to other party (QSO mode)"
},
"messageType" : {
"type" : "integer",
"description" : "type of message to send (LoRaModSettings::MessageType):\n * 0 - No message i.e no output. Use this as a transition to resend the same message.\n * 1 - Beacon. Sends message specified in beaconMessage\n * 2 - CQ call. Sends message specified in cqMessage\n * 3 - Reply to CQ call. Sends message specified in replyMessage\n * 4 - Report to callee. Sends message specified in reportMessage\n * 5 - Report to caller. Sends message specified in replyReportMessage\n * 6 - RRR to callee. Sends message specified in rrrMessage\n * 7 - 73 to caller. Sends message specified in message73\n * 8 - Random message with callsigns. Sends message specified in qsoTextMessage\n * 9 - Plain text. Sends message specified in textMessage\n * 10 - Binary payload. Sends bytes specified in bytesMessage\n"
},
"beaconMessage" : {
"type" : "string",
"description" : "text message to be sent (repeatedly) as a beaconMessage"
},
"cqMessage" : {
"type" : "string",
"description" : "general call message (QSO mode)"
},
"replyMessage" : {
"type" : "string",
"description" : "reply to caller message (QSO mode)"
},
"reportMessage" : {
"type" : "string",
"description" : "report to callee message (QSO mode)"
},
"replyReportMessage" : {
"type" : "string",
"description" : "report back to caller message (QSO mode)"
},
"rrrMessage" : {
"type" : "string",
"description" : "caller RRR message (QSO mode)"
},
"message73" : {
"type" : "string",
"description" : "73 message back to caller to close QSO (QSO mode)"
},
"qsoTextMessage" : {
"type" : "string",
"description" : "QSO random message exchange (QSO mode)"
},
"textMessage" : {
"type" : "string",
"description" : "freeform text message"
},
"bytesMessage" : {
"type" : "array",
"description" : "message to send as an array of hex string represented bytes (00..FF)",
"items" : {
"type" : "string"
}
},
"messageRepeat" : {
"type" : "integer",
"description" : "number of repetitions of the same message (0 for infinite)"
},
"rgbColor" : {
"type" : "integer"
},
@@ -32322,7 +32430,7 @@ except ApiException as e:
</div>
<div id="generator">
<div class="content">
Generated 2020-02-08T20:41:49.295+01:00
Generated 2020-02-22T07:44:51.167+01:00
</div>
</div>
</div>
sdrbase/resources/webapi/doc/swagger/include/LoRaMod.yaml
+100 -2
View File
@@ -9,12 +9,98 @@ LoRaModSettings:
spreadFactor:
type: integer
deBits:
description: Low data rate optmize (DE) bits i.e. nb of FFT bins per effective symbol
type: integer
preambleChirps:
description: Number of preamble chirps
type: integer
quietMillis:
description: Number of milliseconds to pause between transmissions
type: integer
syncWord:
description: 2 byte (0..65535) synchronization syncWord
type: integer
message:
type: string
channelMute:
description: boolean
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
nbParityBits:
description: Hamming FEC parity bits (LoRa)
type: integer
hasCRC:
description: Payload has CRC (LoRa)
type: integer
hasHeader:
description: Header present before actual payload (LoRa)
type: integer
myCall:
description: own callsign placeholder (QSO mode)
type: string
urCall:
description: other party callsign placeholder (QSO mode)
type: string
myLoc:
description: own QRA locator (QSO mode)
type: string
myRpt:
description: report sent to other party (QSO mode)
type: string
messageType:
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
* 10 - Binary payload. Sends bytes specified in bytesMessage
beaconMessage:
description: text message to be sent (repeatedly) as a beaconMessage
type: string
cqMessage:
description: general call message (QSO mode)
type: string
replyMessage:
description: reply to caller message (QSO mode)
type: string
reportMessage:
description: report to callee message (QSO mode)
type: string
replyReportMessage:
description: report back to caller message (QSO mode)
type: string
rrrMessage:
description: caller RRR message (QSO mode)
type: string
message73:
description: 73 message back to caller to close QSO (QSO mode)
type: string
qsoTextMessage:
description: QSO random message exchange (QSO mode)
type: string
textMessage:
description: freeform text message
type: string
bytesMessage:
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
rgbColor:
type: integer
title:
@@ -43,3 +129,15 @@ LoRaModReport:
format: float
channelSampleRate:
type: integer
symbolTimeMs:
description: symbol duration (ms)
type: number
format: float
payloadTimeMs:
description: payload duration (ms)
type: number
format: float
totalTimeMs:
description: total message duration inc. preamble and SFD (ms)
type: number
format: float
sdrbase/resources/webapi/doc/swagger/include/Structs.yaml
+2 -3
View File
@@ -53,7 +53,7 @@ RangeFloat:
format: float
step:
type: number
format: float
format: float
FrequencyRange:
description: An frequency range with 64 bit support for min and max
@@ -74,7 +74,7 @@ NamedEnum:
type: string
value:
type: integer
Complex:
description: A complex number
properties:
@@ -84,4 +84,3 @@ Complex:
imag:
type: number
format: float