RadioHound

RadioHound data format for spectrum monitoring

Type object
File match *.rh.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/radiohound/latest.json
Source https://www.schemastore.org/radiohound-v0.json

Versions

v0

Validate with Lintel

npx @lintel/lintel check
Type: object

Describes a RadioHound capture.

Properties

data string required
format=binary
gain number required
latitude number required

The latitude where the data was captured, in decimal degrees

exclusiveMin=-90.0exclusiveMax=90.0
longitude number required

The longitude where the data was captured, in decimal degrees

exclusiveMin=-180.0exclusiveMax=180.0
mac_address string required

MAC address of the device, without separators

minLength=12maxLength=12
metadata object required

Metadata for a RadioHound capture.

10 nested properties
data_type string required

Data types supported by RadioHound.

Values: "periodogram"
fmax integer required

The maximum frequency in the sample

exclusiveMin=0exclusiveMax=9223372036854775807
fmin integer required

The minimum frequency in the sample

exclusiveMin=0exclusiveMax=9223372036854775807
gps_lock boolean required

Whether a GPS satellite lock is obtained, otherwise the last known coordinates

nfft integer required

Number of FFT bins, recommended to be a power of 2

exclusiveMin=0
scan_time number required

The time taken to scan this sample, in seconds

exclusiveMin=0.0
xcount integer | null

[Deprecated] The number of points in the periodogram

Default: null
xstart integer | null

[Deprecated] The start frequency of the periodogram

Default: null
xstop integer | null

[Deprecated] The stop frequency of the periodogram

Default: null
archive_result boolean | null

Whether the data was archived

Default: null
sample_rate integer required

Sample rate of the capture, in Hz

exclusiveMin=0exclusiveMax=9223372036854775807
short_name string required

The short name of the device

maxLength=255
timestamp string required

Timestamp of the capture start, as ISO 8601 with timezone information

format=date-time
type string required

Numpy-compatible dtype of data elements

version string

Version of the RadioHound data format

Default: "v0"
maxLength=255
altitude number | null

The altitude where the data was captured, in meters

Default: null
center_frequency number | null

The center frequency of the capture, calculated as the mean of the start and end frequencies

Default: null
custom_fields object

Custom fields that are not part of the standard schema

hardware_board_id string | null

The hardware board ID of the device capturing the data

Default: null
hardware_version string | null

The hardware version of the device capturing the data

Default: null
scan_group string | null

The scan group, used to group RH files. UUID version 4 as a 36 char string (with dashes).

Default: null
software_version string | null

The software version of the device capturing the data

Default: null
batch integer | null

[Deprecated | Use scan_group instead] Can be used to group scans together.

Default: null
suggested_gain number | null

[Deprecated] Suggested gain for the device

Default: null
uncertainty integer | null

[Deprecated] Uncertainty of the measurement

Default: null
requested object | null

Attributes set by requestor

Default: null

Definitions

DataType string

Data types supported by RadioHound.

_RHMetadataV0 object

Metadata for a RadioHound capture.

data_type string required

Data types supported by RadioHound.

Values: "periodogram"
fmax integer required

The maximum frequency in the sample

exclusiveMin=0exclusiveMax=9223372036854775807
fmin integer required

The minimum frequency in the sample

exclusiveMin=0exclusiveMax=9223372036854775807
gps_lock boolean required

Whether a GPS satellite lock is obtained, otherwise the last known coordinates

nfft integer required

Number of FFT bins, recommended to be a power of 2

exclusiveMin=0
scan_time number required

The time taken to scan this sample, in seconds

exclusiveMin=0.0
xcount integer | null

[Deprecated] The number of points in the periodogram

Default: null
xstart integer | null

[Deprecated] The start frequency of the periodogram

Default: null
xstop integer | null

[Deprecated] The stop frequency of the periodogram

Default: null
archive_result boolean | null

Whether the data was archived

Default: null