RFKIT (0.9.0)

Download OpenAPI specification:Download

info

getInfo

Returns details about the RFKIT device

Responses

Response samples

200

Content type

application/json

{"device": "B26 RF2K-S",
"software_version": {"GUI": 108,
"controller": 131
},
"custom_device_name": "My custom RFKIT device name"
}

data

getData

Returns some status data

Responses

Response samples

200

Content type

application/json

{"band": {"value": 40,
"unit": "m"
},
"frequency": {"value": 7039,
"unit": "kHz"
},
"status": ""
}

power

getPower

Returns some power data

Responses

Response samples

200

Content type

application/json

{"temperature": {"value": 23.5,
"unit": "°C"
},
"voltage": {"value": 53.3,
"unit": "V"
},
"current": {"value": 0,
"unit": "A"
},
"forward": {"value": 10,
"max_value": 10,
"unit": "W"
},
"reflected": {"value": 0,
"max_value": 0,
"unit": "W"
},
"swr": {"value": 1.15,
"max_value": 1.15,
"unit": ""
}
}

tuner

getTuner

Returns some tuner data

Responses

Response samples

200

Content type

application/json

Example

{"mode": "AUTO",
"setup": "BYPASS",
"tuned_frequency": {"value": 0,
"unit": "kHz"
},
"segment_size": {"value": 75,
"unit": "kHz"
}
}

antennas

getAntennasWithState

Returns the antennas together with their state

Responses

Response samples

200

Content type

application/json

Example

{"antennas": [{"type": "INTERNAL",
"number": 1,
"state": "ACTIVE"
},
{"type": "INTERNAL",
"number": 2,
"state": "AVAILABLE"
},
{"type": "INTERNAL",
"number": 3,
"state": "DISABLED"
},
{"type": "INTERNAL",
"number": 4,
"state": "AVAILABLE"
},
{"type": "EXTERNAL",
"state": "AVAILABLE"
}
]
}

getActiveAntenna

Returns the active antenna

Responses

Response samples

200

Content type

application/json

Example

{"type": "INTERNAL",
"number": 1
}

setActiveAntenna

Set the active antenna

Request Body schema: application/json

The antenna to set active

Any of

type required	string Value: "INTERNAL"
number required	integer <int32> [ 1 .. 4 ]

Responses

Request samples

Payload

Content type

application/json

Example

{"type": "INTERNAL",
"number": 1
}

Response samples

200
400
409

Content type

application/json

Example

{"type": "INTERNAL",
"number": 1
}

operational-interface

getOperationalInterface

Get the operational interface

Responses

Response samples

200

Content type

application/json

{"operational_interface": "UNIV",
"error": "string"
}

setOperationalInterface

Set the operational interface

Request Body schema: application/json

The operational interface to set active

operational_interface

required

string

Enum: "UNIV" "CAT" "UDP" "TCI"

Responses

Request samples

Payload

Content type

application/json

{"operational_interface": "UNIV"
}

Response samples

200
400

Content type

application/json

{"operational_interface": "UNIV",
"error": "string"
}

error

resetError

Reset error state

Responses

Response samples

409

Content type

application/json

{"status": "string",
"reason": "string"
}

operate-mode

getOperateMode

Get whether RFKIT is in Operate or Standby mode

Responses

Response samples

200

Content type

application/json

{"operate_mode": "OPERATE"
}

setOperateMode

Set RFKIT to Operate or Standby

Request Body schema: application/json

The operate mode to set

operate_mode

required

string

Enum: "OPERATE" "STANDBY"

Responses

Request samples

Payload

Content type

application/json

{"operate_mode": "OPERATE"
}

Response samples

200
400
409

Content type

application/json

{"operate_mode": "OPERATE"
}