You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

181 lines
5.2 KiB

ChirpModemModSettings:
description: ChirpModem modulator settings (libchirpmodem transmitter, format v1)
type: object
properties:
inputFrequencyOffset:
type: integer
format: int64
spreadFactor:
type: integer
format: int32
description: Spreading factor
default: 9
minimum: 7
maximum: 12
bandwidth:
type: integer
format: int32
description: Chip rate, equal to the occupied bandwidth, in Hz. 62500 and 125000 are in use
default: 62500
minimum: 1000
maximum: 2000000
mode:
type: integer
format: int32
description: "Payload mode: -1 auto (non-coherent at SF >= 10 or BW <= 62.5 kHz), 0 non-coherent, 1 coherent"
default: -1
enum: [-1, 0, 1]
profile:
type: integer
format: int32
description: "0 licensed (amateur: source callsign required, no encryption), 1 unlicensed (ISM)"
default: 0
enum: [0, 1]
source:
type: string
description: Source callsign (A-Z 0-9 - / ., at most 9 characters). Required by the licensed profile
destination:
type: string
description: Destination callsign, empty for none
message:
type: string
description: Body, sent as UTF-8
repeat:
type: integer
format: int32
description: Frames per transmission
default: 1
minimum: 1
maximum: 1000
gap:
type: number
format: float
description: Silence between frames and before the CW ID, in seconds
default: 0.5
minimum: 0
maximum: 60
amplitude:
type: number
format: float
description: Peak amplitude, 0 to 1 of full scale
default: 0.7
minimum: 0
maximum: 1
cwId:
type: integer
format: int32
description: Send "DE <source>" in Morse after each transmission (47 CFR 97.119). Turning it off in the licensed profile is reported as a warning
default: 1
enum: [0, 1]
cwWpm:
type: integer
format: int32
description: CW ID speed in words per minute, at most 20 (47 CFR 97.119(b)(1))
default: 20
minimum: 5
maximum: 20
rgbColor:
type: integer
format: int32
title:
type: string
streamIndex:
type: integer
format: int32
description: MIMO channel. Not relevant when connected to SO (single Tx).
useReverseAPI:
type: integer
format: int32
description: Synchronize with reverse API (1 for yes, 0 for no)
reverseAPIAddress:
type: string
reverseAPIPort:
type: integer
format: int32
reverseAPIDeviceIndex:
type: integer
format: int32
reverseAPIChannelIndex:
type: integer
format: int32
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
ChirpModemModReport:
description: ChirpModem modulator report
type: object
properties:
channelPowerDb:
type: number
format: double
description: Power of the samples being sent, in dB
channelSampleRate:
type: integer
format: int32
description: Rate the frames are generated at, Hz
ifOffset:
type: integer
format: int32
description: Signal centre within the channel before interpolation, Hz
transmitting:
type: integer
format: int32
description: 1 while a transmission is being sent
queueLength:
type: integer
format: int32
description: Transmissions waiting
framesSent:
type: integer
format: int64
description: Frames sent since the channel started
transmissions:
type: integer
format: int64
description: Transmissions completed since the channel started, each with its CW ID
airtime:
type: number
format: float
description: Seconds of transmissions sent since the channel started
lastDuration:
type: number
format: float
description: Length of the last transmission queued, in seconds
frameSeconds:
type: number
format: float
description: Time on air of one frame with the current settings and message, in seconds
maxBody:
type: integer
format: int32
description: Longest body that fits one frame with the current callsigns, in bytes
lastEvent:
type: string
description: queued, started, sent, aborted or error
lastError:
type: string
description: Why the last request was refused or cut off, empty otherwise
warning:
type: string
description: A configuration that is allowed but needs attention, such as no CW ID in the licensed profile
ChirpModemModActions:
description: ChirpModem modulator actions
type: object
properties:
tx:
type: integer
format: int32
description: "1: transmit. Without src, dst or message, the settings' values are used"
enum: [0, 1]
src:
type: string
description: Source callsign for this transmission only
dst:
type: string
description: Destination callsign for this transmission only
message:
type: string
description: Body for this transmission only, sent as UTF-8