Skip to main content

Popoto JSON Variables

The following variables are available through the Popoto JSON API. Each entry lists the variable's data type, supported range, and access permissions.

VariableDescriptionTypeMinimumMaximumAccess
APP_CycleCountDisplay cycle counterint0.00.0Read Only
APP_CycleCountResetDisplay cycle counter and resetint0.00.0Read Only
APP_ModemSMAOutFlag to send modem data to the SMA port outint0.01.0Read and Write
APP_SocketBasedPCMFlag to enable socket-based PCMint0.01.0Read and Write
BBAND_DownCarrierDownconvert baseband streaming carrier, 5120 to 45000int5120.045000.0Read and Write
BBAND_OutputScaleUpconvert output scaling for baseband passband modulefloat0.010.0Read and Write
BBAND_UpCarrierUpconvert baseband streaming carrier, 5120 to 45000int5120.045000.0Read and Write
BatteryChargeBattery charge in mAhfloat0.0271.98999Read and Write
BatteryCurrentBattery current in positive (to battery; unused) or negative (from battery) mAfloat0.0200.0Read Only
BatteryVoltageSystem battery voltage in voltsfloat0.040.0Read Only
CarrierSets both transmit and receiver carriers. Reading this variable returns the transmitter carrier.int20000.059750.0Read and Write
CarrierTxModeSet the transmitter to send the FH waveform (0, default) or a carrier note (1)int0.01.0Read and Write
ChannelIRMeasured channel impulse response; getter returns number of expected valuesint0.00.0Read Only
ConsolePacketBytesNumber of console characters input to trigger an autosendint0.08192.0Read and Write
ConsoleTimeoutMSNumber of console milliseconds elapsed to trigger an autosendint0.060000.0Read and Write
DOWNCONVERT_CarrierDownconverter carrier frequency in Hzint20000.059750.0Read and Write
DataPortModeData port acts as Telnet (0) or raw TCP data (1)int0.01.0Read and Write
DepartureDelay_samplesTransmit departure delayint0.03072000.0Read and Write
DopplerDisableDoppler compensation off (0) or on (1)int0.01.0Read and Write
DopplerEnableDisable (0) or enable (1) Doppler estimationint0.01.0Read and Write
FHDEMOD_DetectThresholdDBDetection threshold for signal acquisition; default is approximately 160 for -5 dB AWGN detectionfloat0.0300.0Read and Write
FHDEMOD_HopSeqLenSet the demodulator hop sequence lengthint1.08192.0Read and Write
FHMOD_HopSeqLenSet the modulator hop sequence lengthint1.08192.0Read and Write
FHMOD_NumChipRepsSet the hop frequency redundancy for payloadsint1.04.0Read and Write
GainAdjustModeSet gain mode: low gain (0), high gain (1), or automatic (2)int0.02.0Read and Write
HP_FilterEnableDisable (0) or enable (1) the high-pass filterint0.01.0Read and Write
HeaderlessEnable headerless streaming mode (0 is default)int0.01.0Read and Write
InBandNoiseEnergyNoise energy measured after the downsampling filterfloat0.01.0Read Only
InbandEnergyIn-band energy parameterfloat0.00.0Read Only
LedEnableDisable all board LEDs (0) or enable board LEDs (1)int0.01.0Read and Write
LocalIDLocal modem ID, 0–254; 255 is broadcastint0.0255.0Read and Write
LoggingLevelLogging verbosity levelint0.05.0Read and Write
MODEM_EnableDisable (0) or enable (1) modem processingint0.01.0Read and Write
PSK_BnTapsNumber of backward taps for the PSK equalizer. Forward plus backward taps must be less than the maximum value.int0.0100.0Read and Write
PSK_ConstellationReturns the last 64 constellation points from the PSK modemfloat0.00.0Read Only
PSK_FnTapsNumber of forward taps for the PSK fractional (N/2) equalizer. Forward plus backward taps must be less than the maximum value.int0.0100.0Read and Write
PSK_PDSNRPost-detection SNR for PSKint0.01.0Read Only
PSK_PLLReturns the PLL errorfloat0.00.0Read Only
PSK_TapsReturns the current equalizer taps as an array with forward taps concatenated with backward tapsfloat0.00.0Read Only
PayloadModePayload bit rate: FH (0), QPSK 5120 bps (1), QPSK 2560 bps (2), QPSK 1920 bps (3), QPSK 1280 bps (4), BPSK 2560 bps (5), BPSK 1280 bps (6), BPSK 960 bps (7), or BPSK 640 bps (8)int0.08.0Read and Write
PeakEnvelopePowerPeak envelope power of the previous transmissionfloat0.00.0Read Only
PlayModePlay in passband (0) or baseband (1)int0.01.0Read and Write
RNG_SpeedOfSoundSpeed of sound in meters per second; adjust for water salinity and other conditionsfloat340.01600.0Read and Write
RNG_TA_DelayMsRanging hold time in milliseconds before a modem responds to a range requestint2500.08000.0Read and Write
RangeTimeout_mSRange reply timeout in millisecondsint0.060000.0Read and Write
RecordModeRecord in passband (0), baseband (1), or dual channel (2)int0.02.0Read and Write
RemoteIDRemote modem ID, 0–254; 255 is broadcastint0.0255.0Read and Write
ReportErroredBytesControl whether bytes in a bad-CRC packet are reportedint0.01.0Read and Write
RxEnableDisable (0) or enable (1) receiver processingint0.01.0Read and Write
RxScramblerModeDisable (0) or enable (1) the receive scramblerint0.01.0Read and Write
SNRSNR estimatefloat0.00.0Read Only
SSB_EnableEnable SSB; default is 0int0.01.0Read and Write
SSB_NREnableEnable SSB advanced squelch, AGC, and noise reductionint0.01.0Read and Write
SSB_SetPTTSet the SSB push-to-talk state from the consoleint0.01.0Read and Write
SSB_SqLevelSSB squelch threshold; 0 is always on and the default is 0.005float0.01.0Read and Write
SSB_TxpowerSSB output power scale; default is 1float0.0100.0Read and Write
SSB_UseGPIOProcess J7 P3 GPIO 8/6 and P9 GPIO 7/14 switches; default is 0int0.01.0Read and Write
SSB_VolumeSSB speaker volume; default is 1float0.0100.0Read and Write
SSB_VxHangSSB VOX hangover switch time in seconds; default is 2.0float0.010.0Read and Write
SSB_VxLevelSSB VOX switching threshold; 0 is always on and the default is 0.005float0.01.0Read and Write
SSB_VxModeDisable (0) or enable (1) voice-activated PTT (VOX)int0.01.0Read and Write
SSB_carrierSet the SSB transmit and receive carrierint22000.035000.0Read and Write
SSB_sidebandSet SSB sideband to lower (0) or upper (1)int0.01.0Read and Write
SignalEnergySignal energy measured during the last FH acquisitionfloat0.01.0Read Only
StreamingTxLenSize of the superpacket when streaming or uploadingint0.08192.0Read and Write
SystemModeSystem mode: data modem (0), SSB (1), data modem and SSB (2), or SMA input to transmit (3)int0.04.0Read and Write
TCPechoDisable (0) or enable (1) TCP echo in the Telnet transmit streamint0.01.0Read and Write
Temp_AmbientAmbient bottle temperature in degrees Celsiusfloat0.00.0Read Only
TxChirpModeDisable (0) or enable (1) chirps before transmitted packetsint0.01.0Read and Write
TxEnableDisable (0) or enable (1) transmit processingint0.01.0Read and Write
TxPowerTransmit-power setting on the software scaleint0.0100.0Read and Write
TxPowerWattsLegacy transmit-power setting variable; this value is not a specified acoustic output in wattsfloat0.01000.0Read and Write
TxTimeout_mSTransmit timeout in millisecondsint0.060000.0Read and Write
UPCONVERT_CarrierUpconverter carrier frequency in Hzint20000.059750.0Read and Write
UPCONVERT_OutputScaleUpconverter output scalefloat0.010.0Read and Write
UnitTestModeWhen set to 1, pump data deterministically from a socket and disable recording and playback timeoutsint0.01.0Read and Write
brdStateBoard stateint0.00.0Read Only
rxStatePresent receiver stateint0.00.0Read Only
tpaStatePower amplifier stateint0.00.0Read Only