WizziLab / modem_ref_v5_3_217

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   modem_ref_helper_for_v5_3_217

Embed: (wiki syntax)

« Back to documentation index

D7A 1.x API
Data Structures | Modules | Enumerations | Enumerator | Variables

D7A 1.x API

======================================================================= More...

Data Structures

union  d7a_vid_ctrl_t
 ======================================================================= ======================================================================= More...
union  d7a_phy_duty_cfg_t
 PHY Duty configuration. More...
union  d7a_phy_status_ch_id_t
 PHY Channel Status Identifier. More...
union  d7a_nf_ctrl_t
 Noise Floor computation control structure. More...
union  d7a_nwl_ssr_filter_t
 ======================================================================= ======================================================================= More...
union  d7a_nls_status_bmp_t
 ======================================================================= ======================================================================= More...
struct  d7a_tp_ack_status_zip_t
 ======================================================================= ======================================================================= More...
union  d7a_agc_ctrl_t
 ======================================================================= ======================================================================= More...
union  d7a_sel_filter_t
 SEL segment filter options structure. More...
union  d7a_cca_cfg_t
 ======================================================================= ======================================================================= More...

Modules

 D7A API (all except APL)

Enumerations

enum  d7a_device_t { D7A_DEVICE_EP = 0, D7A_DEVICE_SC, D7A_DEVICE_GW, D7A_DEVICE_QTY }
 

======================================================================= =======================================================================

More...
enum  d7a_eng_mode_t { D7A_ENG_MODE_NORMAL = 0, D7A_ENG_MODE_SCP = 2, D7A_ENG_MODE_SNIFFER = 3 }
 

======================================================================= =======================================================================

More...
enum  d7a_ext_t { D7A_EXT_FSK = 0, D7A_EXT_OTHER = 1 }
 

======================================================================= =======================================================================

More...
enum  d7a_class_t {
  D7A_CLASS_LO = 0, D7A_CLASS_RFU, D7A_CLASS_NORMAL, D7A_CLASS_HI,
  D7A_CLASS_QTY
}
 

Enumerator of the nominal PHY channel classes.

More...
enum  d7a_class_ext_t {
  D7A_CLASS_EXT_LORA = 0, D7A_CLASS_EXT_RFU_1, D7A_CLASS_EXT_UNB, D7A_CLASS_EXT_UWB,
  D7A_CLASS_EXT_QTY
}
 

Enumerator of the Extended channel classes.

More...
enum  d7a_band_t {
  D7A_BAND_000 = 0, D7A_BAND_RFU_1 = 1, D7A_BAND_433 = 2, D7A_BAND_868 = 3,
  D7A_BAND_915 = 4, D7A_BAND_RFU_5 = 5, D7A_BAND_2400 = 6, D7A_BAND_UWB = 7,
  D7A_BAND_QTY
}
 

Enumerator of the PHY channel bands.

More...
enum  d7a_cs_t {
  D7A_CS_0 = 0, D7A_CS_1, D7A_CS_2, D7A_CS_3,
  D7A_CS_QTY
}
 

Enumerator of the PHY channel coding schemes.

More...
enum  d7a_nf_auto_t { D7A_NF_AUTO_NO = 0, D7A_NF_AUTO_SLOW = 1 }
 

======================================================================= =======================================================================

More...
enum  d7a_area_t
 

DLL Area Enumerator.

More...
enum  d7a_nwl_routing_mode_t { D7A_NWL_ROUTING_MODE_DEFAULT = 0, D7A_NWL_ROUTING_MODE_QTY }
 

======================================================================= =======================================================================

More...

Variables

u8   bteq: 1
 Btag acceptance condition (0 : differ, 1 : equal)
u8   en: 1
 Declare myself using VID instead of UID.
u8 byte
 byte access
u8   rfu: 3
 RFU.
u8   sub_nb: 4
 When the widow type is sliding, number of sub-windows.
u8 word
 word access
u16   rfu: 1
 RFU.
u16   lo: 1
 Channel bandwidth (1 : 25 kHz, 0 : 200 kHz)
u16   band: 3
 Band.
u16 word
 word access
u8   vcast: 1
 Allow new entry to be added on unicast access with Virtual ID.
u8   bcast: 1
 Allow new entry to be added on broadcast access.
u8   rfu: 2
 RFU.
u8   oldkey: 1
 Accept old keys from the keyring and reply using the key of the request.
u8   flushen: 1
 Enable flush on regular basis.
u8   flushreq: 1
 Flush on every received initial request.
u8   ssr_ovf: 1
 SSR filter overflow.
u8   rfu: 6
 RFU.
u8 start_id
 First non-received ID, before which all IDs are receive.
u8 end_id
 Last received ID.
u8 bitmap [32]
 Reception status bitmap.
u8   rxlev: 1
 Enable target RXLEV reporting When set, the target RXLEV is provided by the transmitting party in the DLL header.
u8   toggle: 1
 Toggle between min and max On a first failure or when the field is not set, the transmission power is set to the maximum authorized level.
u8   csma_err: 1
 Do not count TX CSMA-CA errors as ACK failures.
u8   duty_err: 1
 Do not count TX duty errors as ACK failures.
u8   opt: 1
 CCA not required flag.

Detailed Description

=======================================================================

Enumeration Type Documentation

enum d7a_area_t

DLL Area Enumerator.

Definition at line 596 of file d7a_1x_fs.h.

enum d7a_band_t

Enumerator of the PHY channel bands.

Enumerator:
D7A_BAND_000 

Universal Band 0.0 to 1684 MHz.

D7A_BAND_RFU_1 

RFU (band 315 MHz ?)

D7A_BAND_433 

Band 433.060 to 434.785 MHz.

D7A_BAND_868 

Band 863.000 to 870.000 MHz.

D7A_BAND_915 

Band 902.000 to 928.000 MHz.

D7A_BAND_RFU_5 

RFU.

D7A_BAND_2400 

Band 2400.000 to 2480.000 MHz.

D7A_BAND_UWB 

Band 3.1 to 10.6 GHz exclusively for UWB usage.

D7A_BAND_QTY 

Quantity.

Definition at line 387 of file d7a_1x_fs.h.

enum d7a_class_ext_t

Enumerator of the Extended channel classes.

Enumerator:
D7A_CLASS_EXT_LORA 

LoRa modulation.

D7A_CLASS_EXT_RFU_1 

Reserved.

D7A_CLASS_EXT_UNB 

Sigfox / UNB modulation.

D7A_CLASS_EXT_UWB 

Decawave / UWB modulation (PHY 802.15.4a)

D7A_CLASS_EXT_QTY 

Quantity.

Definition at line 367 of file d7a_1x_fs.h.

enum d7a_class_t

Enumerator of the nominal PHY channel classes.

Enumerator:
D7A_CLASS_LO 

Lo-Rate, 9.6 kbps, 4.8 kHz deviation.

D7A_CLASS_RFU 

Reserved.

D7A_CLASS_NORMAL 

Normal-Rate, 55.555 kbps, 50 kHz deviation.

D7A_CLASS_HI 

Hi-Rate, 166.667 kbps, 41.667 kHz deviation.

D7A_CLASS_QTY 

Quantity.

Definition at line 347 of file d7a_1x_fs.h.

enum d7a_cs_t

Enumerator of the PHY channel coding schemes.

Enumerator:
D7A_CS_0 

Nominal - PN9 encoding Extension LoRa - LoRaWAN mode 0 (BW = 125 KHz, SF = 12, FEC 4/5) Extension UNB - TBD Extension UWB - rate 110 kbps.

D7A_CS_1 

Nominal - 1/2 FEC + punc 1/4 + PN9 encoding Extension LoRa - LoRaWAN mode 1 (BW = 125 KHz, SF = 11, FEC 4/5) Extension UNB - TBD Extension UWB - rate 850 kbps.

D7A_CS_2 

Nominal - 1/2 FEC + PN9 encoding Extension LoRa - LoRaWAN mode 2 (BW = 125 KHz, SF = 10, FEC 4/5) Extension UNB - TBD Extension UWB - rate 6.8 Mbps.

D7A_CS_3 

Nominal - RFU Extension LoRa - LoRaWAN mode 3 (BW = 125 KHz, SF = 8, FEC 4/5) Extension UNB - TBD Extension UWB - TBD.

D7A_CS_QTY 

Quantity.

Definition at line 415 of file d7a_1x_fs.h.

enum d7a_device_t

======================================================================= =======================================================================

3. DEVICE CAPACITY

======================================================================= ======================================================================= Enumerator of the device types

Enumerator:
D7A_DEVICE_EP 

Endpoint.

D7A_DEVICE_SC 

Subcontroller.

D7A_DEVICE_GW 

Gateway.

D7A_DEVICE_QTY 

Quantity.

Definition at line 163 of file d7a_1x_fs.h.

enum d7a_eng_mode_t

======================================================================= =======================================================================

5. ENG

======================================================================= ======================================================================= Enumerator of the Engineering modes

Enumerator:
D7A_ENG_MODE_NORMAL 

Normal Mode param : not used.

D7A_ENG_MODE_SCP 

Spectrum Control Protocol flooding param[0] : access class param[1] : flooding duration in seconds (CTF)

D7A_ENG_MODE_SNIFFER 

Sniffer param : not used.

Definition at line 246 of file d7a_1x_fs.h.

enum d7a_ext_t

======================================================================= =======================================================================

8. PHY CONFIGURATION

======================================================================= ======================================================================= Enumerator of the PHY channel extensions

Enumerator:
D7A_EXT_FSK 

Nominal D7A channels (FSK modulation)

D7A_EXT_OTHER 

Other D7A channels.

Definition at line 333 of file d7a_1x_fs.h.

enum d7a_nf_auto_t

======================================================================= =======================================================================

10. DLL CONFIGURATION

======================================================================= ======================================================================= DLL Noise Floor Autoscaling

Enumerator:
D7A_NF_AUTO_NO 

No Autoscaling (default).

Always use the Noise Floor and Noise Floor Variance defined in the Access Profile

D7A_NF_AUTO_SLOW 

Slow RSSI Variation.

Noise Floor and Noise Floor variance are computed based on regular RSSI measurements with a forget factor defined by the associated parameter

Definition at line 579 of file d7a_1x_fs.h.

enum d7a_nwl_routing_mode_t

======================================================================= =======================================================================

12. NWL ROUTING

======================================================================= ======================================================================= NWL routing modes

Enumerator:
D7A_NWL_ROUTING_MODE_DEFAULT 

Default routing type.

D7A_NWL_ROUTING_MODE_QTY 

Qty.

Definition at line 747 of file d7a_1x_fs.h.

Variable Documentation

u16 band [inherited]

Band.

Definition at line 518 of file d7a_1x_fs.h.

u16 band [inherited]

Band.

Definition at line 518 of file d7a_1x_fs.h.

u8 bcast [inherited]

Allow new entry to be added on broadcast access.

Definition at line 848 of file d7a_1x_fs.h.

u8 bcast [inherited]

Allow new entry to be added on broadcast access.

Definition at line 848 of file d7a_1x_fs.h.

u8 bitmap[32] [inherited]

Reception status bitmap.

Definition at line 998 of file d7a_1x_fs.h.

u8 bteq [inherited]

Btag acceptance condition (0 : differ, 1 : equal)

Definition at line 295 of file d7a_1x_fs.h.

u8 bteq [inherited]

Btag acceptance condition (0 : differ, 1 : equal)

Definition at line 295 of file d7a_1x_fs.h.

u8 byte [inherited]

byte access

Definition at line 301 of file d7a_1x_fs.h.

u8 csma_err [inherited]

Do not count TX CSMA-CA errors as ACK failures.

Definition at line 1080 of file d7a_1x_fs.h.

u8 csma_err [inherited]

Do not count TX CSMA-CA errors as ACK failures.

Definition at line 1080 of file d7a_1x_fs.h.

u8 duty_err [inherited]

Do not count TX duty errors as ACK failures.

Definition at line 1082 of file d7a_1x_fs.h.

u8 duty_err [inherited]

Do not count TX duty errors as ACK failures.

Definition at line 1082 of file d7a_1x_fs.h.

u8 en [inherited]

Declare myself using VID instead of UID.

Definition at line 297 of file d7a_1x_fs.h.

u8 en [inherited]

Declare myself using VID instead of UID.

Definition at line 297 of file d7a_1x_fs.h.

u8 end_id [inherited]

Last received ID.

Definition at line 996 of file d7a_1x_fs.h.

u8 flushen [inherited]

Enable flush on regular basis.

Definition at line 854 of file d7a_1x_fs.h.

u8 flushen [inherited]

Enable flush on regular basis.

Definition at line 854 of file d7a_1x_fs.h.

u8 flushreq [inherited]

Flush on every received initial request.

Definition at line 856 of file d7a_1x_fs.h.

u8 flushreq [inherited]

Flush on every received initial request.

Definition at line 856 of file d7a_1x_fs.h.

u16 lo [inherited]

Channel bandwidth (1 : 25 kHz, 0 : 200 kHz)

Definition at line 516 of file d7a_1x_fs.h.

u16 lo [inherited]

Channel bandwidth (1 : 25 kHz, 0 : 200 kHz)

Definition at line 516 of file d7a_1x_fs.h.

u8 oldkey [inherited]

Accept old keys from the keyring and reply using the key of the request.

Definition at line 852 of file d7a_1x_fs.h.

u8 oldkey [inherited]

Accept old keys from the keyring and reply using the key of the request.

Definition at line 852 of file d7a_1x_fs.h.

u8 opt [inherited]

CCA not required flag.

Definition at line 1217 of file d7a_1x_fs.h.

u8 opt [inherited]

CCA not required flag.

Definition at line 1217 of file d7a_1x_fs.h.

u8 rfu [inherited]

RFU.

Definition at line 850 of file d7a_1x_fs.h.

u8 rfu [inherited]

RFU.

Definition at line 453 of file d7a_1x_fs.h.

u8 rfu [inherited]

RFU.

Definition at line 929 of file d7a_1x_fs.h.

u8 rfu [inherited]

RFU.

Definition at line 929 of file d7a_1x_fs.h.

u8 rfu [inherited]

RFU.

Definition at line 453 of file d7a_1x_fs.h.

u8 rfu [inherited]

RFU.

Definition at line 850 of file d7a_1x_fs.h.

u16 rfu [inherited]

RFU.

Definition at line 514 of file d7a_1x_fs.h.

u16 rfu [inherited]

RFU.

Definition at line 514 of file d7a_1x_fs.h.

u8 rxlev [inherited]

Enable target RXLEV reporting When set, the target RXLEV is provided by the transmitting party in the DLL header.

The target RXLEV is computed based on local noise floor, channel class and device sensitivity

Definition at line 1051 of file d7a_1x_fs.h.

u8 rxlev [inherited]

Enable target RXLEV reporting When set, the target RXLEV is provided by the transmitting party in the DLL header.

The target RXLEV is computed based on local noise floor, channel class and device sensitivity

Definition at line 1051 of file d7a_1x_fs.h.

u8 ssr_ovf [inherited]

SSR filter overflow.

Definition at line 927 of file d7a_1x_fs.h.

u8 ssr_ovf [inherited]

SSR filter overflow.

Definition at line 927 of file d7a_1x_fs.h.

u8 start_id [inherited]

First non-received ID, before which all IDs are receive.

Definition at line 994 of file d7a_1x_fs.h.

u8 sub_nb [inherited]

When the widow type is sliding, number of sub-windows.

This parameter is used to manage properly the duty limit without having to record every unitary TX event. Instead the duty is always limited to (sub_nb-1)/sub_nb and the duty credit never exceeds 1/sub_nb of the maximum available duty over the window (sliding sub-window). The bigger is sub_nb, the closer the credited duty is to the duty limit, but the smaller is the immediate available credit. For regular transmission of small packets, sub_nb can be kept high (> 10). For rare transmissions of long packets, sub_nb shall be kept small (< 5).

Definition at line 465 of file d7a_1x_fs.h.

u8 sub_nb [inherited]

When the widow type is sliding, number of sub-windows.

This parameter is used to manage properly the duty limit without having to record every unitary TX event. Instead the duty is always limited to (sub_nb-1)/sub_nb and the duty credit never exceeds 1/sub_nb of the maximum available duty over the window (sliding sub-window). The bigger is sub_nb, the closer the credited duty is to the duty limit, but the smaller is the immediate available credit. For regular transmission of small packets, sub_nb can be kept high (> 10). For rare transmissions of long packets, sub_nb shall be kept small (< 5).

Definition at line 465 of file d7a_1x_fs.h.

u8 toggle [inherited]

Toggle between min and max On a first failure or when the field is not set, the transmission power is set to the maximum authorized level.

When the field is set, on a subsequent failure, the transmission power is toggled between the minimum possible level and the maximum authorized levels.

Definition at line 1058 of file d7a_1x_fs.h.

u8 toggle [inherited]

Toggle between min and max On a first failure or when the field is not set, the transmission power is set to the maximum authorized level.

When the field is set, on a subsequent failure, the transmission power is toggled between the minimum possible level and the maximum authorized levels.

Definition at line 1058 of file d7a_1x_fs.h.

u8 vcast [inherited]

Allow new entry to be added on unicast access with Virtual ID.

Definition at line 846 of file d7a_1x_fs.h.

u8 vcast [inherited]

Allow new entry to be added on unicast access with Virtual ID.

Definition at line 846 of file d7a_1x_fs.h.

u8 word [inherited]

word access

Definition at line 469 of file d7a_1x_fs.h.

u16 word [inherited]

word access

Definition at line 522 of file d7a_1x_fs.h.

Generated on Wed Jul 20 2022 12:33:07 by  doxygen 1.7.2