From be983c74c142639bdb4a08faeea4da6709834dc7 Mon Sep 17 00:00:00 2001 From: christianrowlands Date: Mon, 4 Dec 2023 18:27:50 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20christia?= =?UTF-8?q?nrowlands/network-survey-messaging@3e53aedcc2b645f2953825cb7b7b?= =?UTF-8?q?f3251489b904=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- index.html | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/index.html b/index.html index e8d06da..d7355a3 100644 --- a/index.html +++ b/index.html @@ -3,7 +3,7 @@ - Network Survey Messaging API 0.13.1 documentation + Network Survey Messaging API 0.14.0 documentation @@ -11,7 +11,7 @@ -
Network Survey Messaging API 0.13.1

The Network Survey Messaging API defines a set of messages that can be used to describe +

Network Survey Messaging API 0.14.0

The Network Survey Messaging API defines a set of messages that can be used to describe wireless survey related events. The messages range from cellular surveys such as GSM, CDMA, UMTS, and LTE, to simple RF energy detection events.

While the most common use of these messages would be to send to an MQTT broker, this API specification @@ -56,7 +56,7 @@

servingCell
boolean

Boolean indicating if this record represents a serving cell record, or a neighbor cell record. If the field is unset then it is unknown if this record is for the serving cell or a neighbor cell. A value of true indicates that the record represents a serving cell, a value of false indicates a neighbor record.

provider
string

The company providing the cellular service.

Additional properties are allowed.

Additional properties are allowed.

Examples

servingCell
boolean

Boolean indicating if this record represents a serving cell record, or a neighbor cell record. If the field is unset then it is unknown if this record is for the serving cell or a neighbor cell. A value of true indicates that the record represents a serving cell, a value of false indicates a neighbor record.

provider
string

The company providing the cellular service.

Additional properties are allowed.

Additional properties are allowed.

Examples

servingCell
boolean

Boolean indicating if this record represents a serving cell record, or a neighbor cell record. If the field is unset then it is unknown if this record is for the serving cell or a neighbor cell. A value of true indicates that the record represents a serving cell, a value of false indicates a neighbor record.

provider
string

The company providing the cellular service.

Additional properties are allowed.

Additional properties are allowed.

Examples

lteBandwidth
string

The LTE downlink bandwidth in MHz (one of 1.4, 3, 5, 10, 15, 20).

    Allowed values:
  • "UNKNOWN"
  • "MHZ_1_4"
  • "MHZ_3"
  • "MHZ_5"
  • "MHZ_10"
  • "MHZ_15"
  • "MHZ_20"
provider
string

The company providing the cellular service.

Additional properties are allowed.

Additional properties are allowed.

Examples

servingCell
boolean

Boolean indicating if this record represents a serving cell record, or a neighbor cell record. If the field is unset then it is unknown if this record is for the serving cell or a neighbor cell. A value of true indicates that the record represents a serving cell, a value of false indicates a neighbor record.

provider
string

The company providing the cellular service.

Additional properties are allowed.

Additional properties are allowed.

Examples

nodeType
string

The type of station that sent this frame.

    Allowed values:
  • "UNKNOWN"
  • "AP"
  • "NON_AP_STA"
  • "STA"
standard
string

The 802.11 standard being employed by the device.

    Allowed values:
  • "UNKNOWN"
  • "IEEE80211"
  • "IEEE80211A"
  • "IEEE80211B"
  • "IEEE80211G"
  • "IEEE80211BG"
  • "IEEE80211N"
  • "IEEE80211AC"
  • "IEEE80211AX"

Additional properties are allowed.

Additional properties are allowed.

Examples

nodeType
string

The type of station that sent this frame.

    Allowed values:
  • "UNKNOWN"
  • "AP"
  • "NON_AP_STA"
  • "STA"
standard
string

The 802.11 standard being employed by the device.

    Allowed values:
  • "UNKNOWN"
  • "IEEE80211"
  • "IEEE80211A"
  • "IEEE80211B"
  • "IEEE80211G"
  • "IEEE80211BG"
  • "IEEE80211N"
  • "IEEE80211AC"
  • "IEEE80211AX"

Additional properties are allowed.

Additional properties are allowed.

Examples

nodeType
string

The type of station that sent this frame.

    Allowed values:
  • "UNKNOWN"
  • "AP"
  • "NON_AP_STA"
  • "STA"
standard
string

The 802.11 standard being employed by the device.

    Allowed values:
  • "UNKNOWN"
  • "IEEE80211"
  • "IEEE80211A"
  • "IEEE80211B"
  • "IEEE80211G"
  • "IEEE80211BG"
  • "IEEE80211N"
  • "IEEE80211AC"
  • "IEEE80211AX"

Additional properties are allowed.

Additional properties are allowed.

Examples

frameSubtype
integer
format: int32>= 0

The subtype of the 802.11 message that corresponds to the frame type. The frame subtype represents the subtype of the 802.11 frame that the pcapRecord field contains. For example, if the frame type is 0 (aka Management) a frame subtype of 0 represents an association request, 1 represents an association response, 2 represents a reassociation request, etc.

pcapRecord
required
string
format: byte

The raw cellular message bytes encoded in base64. The bytes in this field are the raw message bytes captured from the Over The Air (OTA) cellular radio frame with the appropriate PCAP headers as the prefix. In other words, the bytes are the same bytes that would show up in a pcap file for a cellular message. The general structure consists of a PCAP record header, PPI header, layer 3 header, layer 4 header, a GSMTAP header, followed by the cellular OTA message. Using this structure means that Wireshark, tshark or any other tool that can read GSMTAP pcap records can easily parse out the contents of this message. For more details see the Network Survey+ Android App Source Code.

Additional properties are allowed.

Additional properties are allowed.

Examples

otaDeviceName
string

The Bluetooth device name is the user-friendly name that a Bluetooth device exposes to remote devices. See the BLUETOOTH SPECIFICATION Version 5.0 | Vol 3, Part C Section 3.2.2 (page 1988) for more details.

channel
integer
format: int32[ 0 .. 78 ]

The channel on which this frame was recorded. See the BLUETOOTH SPECIFICATION Version 5.0 | Vol 2, Part A Section 2 (page 325) for more details.

Additional properties are allowed.

Additional properties are allowed.

Examples

hdop
number
format: float[ 0 .. 50 ]

Horizontal Dilution of Precision. Valid range, 0.0 to 50.0.

vdop
number
format: float[ 0 .. 50 ]

Vertical Dilution of Precision. Valid range, 0.0 to 50.0.

Additional properties are allowed.

Additional properties are allowed.

Examples

timeUp
string
format: date-time

The date & time the energy/signal was detected as active. This is formatted as an RFC3339 date-time. For example, '1996-12-19T16:39:57-08:00'.

durationSec
number
format: float> 0

The duration of time, in seconds, that the signal was detected as active.

Additional properties are allowed.

Additional properties are allowed.

Examples

modulation
string

The modulation type found on the received signal. It is appropriate to leave this blank if the modulation of the signal is unknown, but either the modulation or signalName field should be filled out. If neither of them are known then the energyDetection message should be used instead.

signalName
string

The modulation type found on the received signal. It is appropriate to leave this blank if the modulation of the signal is unknown, but either the modulation or signalName field should be filled out. If neither of them are known then the energyDetection message should be used instead.

Additional properties are allowed.

Additional properties are allowed.

Examples

mdmOverride
boolean

Indicates if the device currently has the Mobile Device Mangement (MDM) Override option turned on. If true, the user has forced the MDM options off, if false, the user has left the MDM control in place. Added in version 0.9.0.

Additional properties are allowed.

Additional properties are allowed.

Examples

narfcn
integer
format: int32[ 0 .. 3279165 ]

Downlink NR Absolute Radio Frequency Channel Number, valid range 0 - 3,279,165, defined in 3GPP TS 38.331 version 16.2.0 Release 16 page 784.

pci
integer
format: int32[ 0 .. 1007 ]

NR Physical Cell Identity, valid range 0-1007 as defined in 3GPP TS 38.331 version 16.2.0 Release 16 page 503.

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

Examples

channelType
required
string

The channel type that this message was sent on. The channel type represents the logical channel that the raw cellular message was sent over.

pcapRecord
required
string
format: byte

The raw cellular message bytes encoded in base64. The bytes in this field are the raw message bytes captured from the Over The Air (OTA) cellular radio frame with the appropriate PCAP headers as the prefix. In other words, the bytes are the same bytes that would show up in a pcap file for a cellular message. The general structure consists of a PCAP record header, PPI header, layer 3 header, layer 4 header, a GSMTAP header, followed by the cellular OTA message. Using this structure means that Wireshark, tshark or any other tool that can read GSMTAP pcap records can easily parse out the contents of this message. For more details see the Network Survey+ Android App Source Code.

Additional properties are allowed.

Additional properties are allowed.

Examples

receiverSensitivity
number
format: float>= 0

The minimum signal strength that a receiver can detect, in units of dBm. One can use sensor orientation (heading, pitch, roll) and sensor characterisics (fieldOfView, receiverSensitivity) to form more accurate estimates of the transmitter's position or distance from the sensor.

pcapRecord
required
string
format: byte

The raw cellular message bytes encoded in base64. The bytes in this field are the raw message bytes captured from the Over The Air (OTA) cellular radio frame with the appropriate PCAP headers as the prefix. In other words, the bytes are the same bytes that would show up in a pcap file for a cellular message. The general structure consists of a PCAP record header, PPI header, layer 3 header, layer 4 header, a GSMTAP header, followed by the cellular OTA message. Using this structure means that Wireshark, tshark or any other tool that can read GSMTAP pcap records can easily parse out the contents of this message. For more details see the Network Survey+ Android App Source Code.

Additional properties are allowed.

Additional properties are allowed.

Examples

channelType
required
string

The channel type that this message was sent on. The channel type represents the logical channel that the raw cellular message was sent over.

pcapRecord
required
string
format: byte

The raw cellular message bytes encoded in base64. The bytes in this field are the raw message bytes captured from the Over The Air (OTA) cellular radio frame with the appropriate PCAP headers as the prefix. In other words, the bytes are the same bytes that would show up in a pcap file for a cellular message. The general structure consists of a PCAP record header, PPI header, layer 3 header, layer 4 header, a GSMTAP header, followed by the cellular OTA message. Using this structure means that Wireshark, tshark or any other tool that can read GSMTAP pcap records can easily parse out the contents of this message. For more details see the Network Survey+ Android App Source Code.

Additional properties are allowed.

Additional properties are allowed.

Examples

channelType
required
string

The channel type that this message was sent on. The channel type represents the logical channel that the raw cellular message was sent over.

pcapRecord
required
string
format: byte

The raw cellular message bytes encoded in base64. The bytes in this field are the raw message bytes captured from the Over The Air (OTA) cellular radio frame with the appropriate PCAP headers as the prefix. In other words, the bytes are the same bytes that would show up in a pcap file for a cellular message. The general structure consists of a PCAP record header, PPI header, layer 3 header, layer 4 header, a GSMTAP header, followed by the cellular OTA message. Using this structure means that Wireshark, tshark or any other tool that can read GSMTAP pcap records can easily parse out the contents of this message. For more details see the Network Survey+ Android App Source Code.

Additional properties are allowed.

Additional properties are allowed.

Examples

channelType
required
string

The channel type that this message was sent on. The channel type represents the logical channel that the raw cellular message was sent over.

pcapRecord
required
string
format: byte

The raw cellular message bytes encoded in base64. The bytes in this field are the raw message bytes captured from the Over The Air (OTA) cellular radio frame with the appropriate PCAP headers as the prefix. In other words, the bytes are the same bytes that would show up in a pcap file for a cellular message. The general structure consists of a PCAP record header, PPI header, layer 3 header, layer 4 header, a GSMTAP header, followed by the cellular OTA message. Using this structure means that Wireshark, tshark or any other tool that can read GSMTAP pcap records can easily parse out the contents of this message. For more details see the Network Survey+ Android App Source Code.

Additional properties are allowed.

Additional properties are allowed.

Examples