1
0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-11-19 14:51:47 -05:00
sdrangel/sdrbase/resources/webapi/doc/swagger/include/SimplePTT.yaml

140 lines
3.4 KiB
YAML

SimplePTTSettings:
description: "Simple PTT settings"
properties:
title:
type: string
rgbColor:
type: integer
rxDeviceSetIndex:
description: index of the Rx device set to connect the Rx side to
type: integer
txDeviceSetIndex:
description: index of the Tx device set to connect the Tx side to
type: integer
rx2TxDelayMs:
description: Delay in milliseconds from Rx off to Tx on
type: integer
tx2RxDelayMs:
description: Delay in milliseconds from Tx off to Rx on
type: integer
vox:
type: integer
description: >
Activate vox system
* 0 - not active
* 1 - active
voxEnable:
type: integer
description: >
Allow vox to control PTT
* 0 - vox does not control PTT
* 1 - vox controls PTT
voxLevel:
type: integer
description: Vox threshold level in dB
voxHold:
type: integer
description: Vox hold timeout in milliseconds
audioDeviceName:
type: string
gpioControl:
type: integer
description: >
GPIO control
* 0 - No GPIO control
* 1 - Rx side controls GPIO
* 2 - Tx side controls GPIO
rx2txGPIOEnable:
type: integer
description: >
Enable Rx to Tx GPIO control
* 0 - disable
* 1 - enable
rx2txGPIOMask:
type: integer
format: int8
description: Rx to Tx change GPIO mask
rx2txGPIOValues:
type: integer
format: int8
description: Rx to Tx change GPIO values
rx2txCommandEnable:
type: integer
description: >
Enable Rx to Tx command
* 0 - disable
* 1 - enable
rx2txCommand:
type: string
description: Command to be executed when Rx switches to Tx
tx2rxGPIOEnable:
type: integer
description: >
Enable Tx to Rx GPIO control
* 0 - disable
* 1 - enable
tx2rxGPIOMask:
type: integer
format: int8
description: Tx to Rx change GPIO mask
tx2rxGPIOValues:
type: integer
format: int8
description: Tx to Rx change GPIO values
tx2rxCommandEnable:
type: integer
description: >
Enable Tx to Rx command
* 0 - disable
* 1 - enable
tx2rxCommand:
type: string
description: Command to be executed when Tx switches to Rx
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
reverseAPIAddress:
type: string
reverseAPIPort:
type: integer
reverseAPIFeatureSetIndex:
type: integer
reverseAPIFeatureIndex:
type: integer
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
SimplePTTReport:
description: "Simple PTT report"
properties:
runningState:
type: integer
description: >
Running state
* 0 - not started
* 1 - idle
* 2 - running
* 3 - error
ptt:
type: integer
description: >
PTT status
* 0 - released
* 1 - engaged
SimplePTTActions:
description: "Simple PTT actions"
properties:
run:
type: integer
description: >
Set the plugin running state
* 0 - idle
* 1 - run
ptt:
type: integer
description: >
PTT action
* 0 - release
* 1 - engage