PHY Domain
Procedures
Enumerations
Endianness
This enumeration lists the possible endian values.
Value |
Description |
|---|---|
BIG |
big-endian |
LITTLE |
little-endian |
JammingMode
This enumeration specifies the jamming mode.
Value |
Description |
|---|---|
CONTINUOUS |
Continuous jamming |
REACTIVE |
Reactive jamming |
LoRaCodingRate
This enumeration contains all the possible values for LoRa coding rate.
Value |
Description |
|---|---|
CR45 |
Coding rate 4/5 |
CR46 |
Coding rate 4/6 |
CR47 |
Coding rate 4/7 |
CR48 |
Coding rate 4/8 |
LoRaSpreadingFactor
This enumeration contains all the possible values for LoRa spreading factor.
Value |
Description |
|---|---|
SF7 |
Spreading factor 7 |
SF8 |
Spreading factor 8 |
SF9 |
Spreading factor 9 |
SF10 |
Spreading factor 10 |
SF11 |
Spreading factor 11 |
SF12 |
Spreading factor 12 |
Modulation
This enumeration contains all the possible modulation supported by the PHY domain.
Value |
Description |
|---|---|
ASK |
Amplitude Shift Keying |
FSK |
Frequency Shift Keying |
FOURFSK |
4 Frequency Shift Keying |
GFSK |
Gaussian Frequency Shift Keying |
MSK |
Minimum-Shift Keying |
BPSK |
Binary Phase Shift Keying |
QPSK |
Quadrature Phase Shift Keying |
LORA |
Semtech LoRa |
PhyCommand
This enumeration contains the various PHY commands ID that are required to create the domain supported commands bitmap.
TXPower
This enumeration contains the different transmit power values accepted by WHAD PHY domain.
Value |
Description |
|---|---|
LOW |
Low power |
MEDIUM |
Medium power |
HIGH |
High power |
Messages
GetSupportedFrequenciesCmd
This message requests the supported frequencies for the WHAD interface.
Note
This message has no specific field.
JamCmd
This message sets the WHAD interface in jamming mode.
Field |
Type |
Description |
|---|---|---|
mode |
Jamming mode |
Jammed
This notification message is sent by the WHAD interface when jamming is successful.
Field |
Type |
Description |
|---|---|---|
timestamp |
uint64 |
Timestamp in microseconds |
MonitorCmd
This message sets the WHAD interface in monitor mode on the currently selected frequency.
Note
This message has no specific field.
MonitoringReport
This notification is sent by the WHAD interface to report monitoring values.
Field |
Type |
Description |
|---|---|---|
timestamp |
uint64 |
Timestamp in microseconds |
report |
uint32[] |
Report values |
PacketReceived
This notification message is sent by the WHAD interface when a packet is received.
Field |
Type |
Description |
|---|---|---|
frequency |
uint32 |
Current frequency |
rssi |
int32, optional |
Received signal strength indicator |
timestamp |
uint64, optional |
Timestamp in microseconds |
packet |
bytes |
Packet bytes |
deviation |
uint32 |
Current frequency deviation |
datarate |
uint32 |
Current data rate |
endian |
Current endianness |
|
modulation |
Current modulation |
|
syncword |
bytes |
Current synchronization word |
PacketSent
This message notification is sent by the WHAD interface when a packet has been sent.
Field |
Type |
Description |
|---|---|---|
timestamp |
uint64 |
Timestamp in microseconds |
RawPacketReceived
This notification message is sent by the WHAD interface when a packet is received.
Field |
Type |
Description |
|---|---|---|
frequency |
uint32 |
Current frequency |
rssi |
int32, optional |
Received signal strength indicator |
timestamp |
uint64, optional |
Timestamp in microseconds |
packet |
bytes |
Packet bytes |
iq |
int32[] |
Corresponding IQs |
deviation |
uint32 |
Current frequency deviation |
datarate |
uint32 |
Current data rate |
endian |
Current endianness |
|
modulation |
Current modulation |
|
syncword |
bytes |
Current synchronization word |
ScheduleSendCmd
This message provides the WHAD interface with a packet to send at a specific time.
Field |
Type |
Description |
|---|---|---|
packet |
bytes |
PDU to send |
timestamp |
uint64 |
Timestamp in microseconds |
SchedulePacketResp
This message is sent by the WHAD interface to notify the result of a schedule packet command.
Field |
Type |
Description |
|---|---|---|
id |
int32 |
Schedule packet slot ID |
full |
bool |
Indicate schedule queue is full |
SchedulePacketSent
This message is sent by the WHAD interface to notify the transmission of a schedule packet.
Field |
Type |
Description |
|---|---|---|
id |
int32 |
Schedule packet slot ID |
SendCmd
This message provides the WHAD interface with a PDU to send
Field |
Type |
Description |
|---|---|---|
packet |
bytes |
PDU to send |
SendRawCmd
This message provides the WHAD interface with IQs to send
Field |
Type |
Description |
|---|---|---|
iq |
int32[] |
IQs to send |
Set4FSKModulationCmd
This message sets the WHAD interface in 4FSK mode.
Field |
Type |
Description |
|---|---|---|
deviation |
uint32 |
Frequency deviation in Hz |
SetASKModulationCmd
This message sets the WHAD interface in ASK mode.
Field |
Type |
Description |
|---|---|---|
ook |
bool |
Enable OOK mode |
SetBPSKModulationCmd
This message sets the WHAD interface in BPSK mode.
Note
This message has no specific field.
SetDataRateCmd
This message sets the WHAD interface data rate.
Field |
Type |
Description |
|---|---|---|
rate |
uint32 |
Data rate in bits/second |
SetEndiannessCmd
This message sets the WHAD interface endianness.
Field |
Type |
Description |
|---|---|---|
endianness |
Endianness to use |
SetFrequencyCmd
This message sets the WHAD interface base frequency.
Field |
Type |
Description |
|---|---|---|
frequency |
uint32 |
Frequency in Hz |
SetFSKModulationCmd
This message sets the WHAD interface in FSK mode.
Field |
Type |
Description |
|---|---|---|
deviation |
uint32 |
Frequency deviation in Hz |
SetGFSKModulationCmd
This message sets the WHAD interface in GFSK mode.
Field |
Type |
Description |
|---|---|---|
deviation |
uint32 |
Frequency deviation in Hz |
SetLoRaModulationCmd
This message sets the WHAD interface in LoRa mode.
Field |
Type |
Description |
|---|---|---|
bandwidth |
uint32 |
Bandwidth in Hz |
spreading_factor |
Spreading factor |
|
coding_rate |
Coding rate |
|
preamble_length |
uint32 |
Preamble length in bits |
enable_crc |
bool |
Enable LoRa CRC |
explicit_mode |
bool |
Use LoRa explicit mode |
invert_iq |
bool |
Enable IQ inversion |
SetMSKModulationCmd
This message sets the WHAD interface in MSK mode.
Field |
Type |
Description |
|---|---|---|
deviation |
uint32 |
Frequency deviation in Hz |
SetPacketSizeCmd
This message sets the WHAD interface packet size.
Field |
Type |
Description |
|---|---|---|
packet_size |
uint32 |
Packet size in bytes |
SetQPSKModulationCmd
This message sets the WHAD interface in QPSK mode.
Field |
Type |
Description |
|---|---|---|
offset_qpsk |
bool |
Use an offset |
SetSyncWordCmd
This message sets the WHAD interface synchronization word.
Field |
Type |
Description |
|---|---|---|
sync_word |
bytes |
Synchronization word |
SetTXPowerCmd
This message sets the WHAD interface TX power.
Field |
Type |
Description |
|---|---|---|
tx_power |
Transmit power |
SniffCmd
This message sets the WHAD interface in sniffing mode.
Field |
Type |
Description |
|---|---|---|
iq_stream |
bool |
Enable capture of IQs |
StartCmd
This message activates the currently selected mode. By default, the WHAD interface is in idle mode.
Note
This message has no specific field.
StopCmd
This message stops the current mode and put the WHAD interface into idling mode.
Note
This message has no specific field.
SupportedFrequencyRanges
This message is sent by the WHAD interface to report its supported frequency ranges.
Field |
Type |
Description |
|---|---|---|
frequency_ranges |
List of frequency ranges |
FrequencyRange
This submessage specifies a frequency range.
Field |
Type |
Description |
|---|---|---|
start |
uint32 |
Frequency range start (in Hz) |
end |
uint32 |
Frequency range end (in Hz) |