# {py:mod}`nearlink_sdr.phy.preamble`

```{py:module} nearlink_sdr.phy.preamble
```

```{autodoc2-docstring} nearlink_sdr.phy.preamble
:allowtitles:
```

## Module Contents

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`generate_preamble <nearlink_sdr.phy.preamble.generate_preamble>`
  - ```{autodoc2-docstring} nearlink_sdr.phy.preamble.generate_preamble
    :summary:
    ```
* - {py:obj}`gfsk_preamble_bits <nearlink_sdr.phy.preamble.gfsk_preamble_bits>`
  - ```{autodoc2-docstring} nearlink_sdr.phy.preamble.gfsk_preamble_bits
    :summary:
    ```
* - {py:obj}`psk_preamble_phases <nearlink_sdr.phy.preamble.psk_preamble_phases>`
  - ```{autodoc2-docstring} nearlink_sdr.phy.preamble.psk_preamble_phases
    :summary:
    ```
* - {py:obj}`psk_preamble_symbols <nearlink_sdr.phy.preamble.psk_preamble_symbols>`
  - ```{autodoc2-docstring} nearlink_sdr.phy.preamble.psk_preamble_symbols
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`BW_SYMBOL_RATE <nearlink_sdr.phy.preamble.BW_SYMBOL_RATE>`
  - ```{autodoc2-docstring} nearlink_sdr.phy.preamble.BW_SYMBOL_RATE
    :summary:
    ```
* - {py:obj}`PREAMBLE_CONFIG <nearlink_sdr.phy.preamble.PREAMBLE_CONFIG>`
  - ```{autodoc2-docstring} nearlink_sdr.phy.preamble.PREAMBLE_CONFIG
    :summary:
    ```
````

### API

````{py:data} BW_SYMBOL_RATE
:canonical: nearlink_sdr.phy.preamble.BW_SYMBOL_RATE
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.phy.preamble.BW_SYMBOL_RATE
```

````

````{py:data} PREAMBLE_CONFIG
:canonical: nearlink_sdr.phy.preamble.PREAMBLE_CONFIG
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.phy.preamble.PREAMBLE_CONFIG
```

````

````{py:function} generate_preamble(frame_type: int, symbol_rate_mhz: float = 1.0)
:canonical: nearlink_sdr.phy.preamble.generate_preamble

```{autodoc2-docstring} nearlink_sdr.phy.preamble.generate_preamble
```
````

````{py:function} gfsk_preamble_bits(symbol_rate_mhz: float = 1.0, duration_us: float = 10.0) -> numpy.ndarray
:canonical: nearlink_sdr.phy.preamble.gfsk_preamble_bits

```{autodoc2-docstring} nearlink_sdr.phy.preamble.gfsk_preamble_bits
```
````

````{py:function} psk_preamble_phases(symbol_rate_mhz: float = 1.0, duration_us: float = 10.0) -> numpy.ndarray
:canonical: nearlink_sdr.phy.preamble.psk_preamble_phases

```{autodoc2-docstring} nearlink_sdr.phy.preamble.psk_preamble_phases
```
````

````{py:function} psk_preamble_symbols(symbol_rate_mhz: float = 1.0, duration_us: float = 10.0) -> numpy.ndarray
:canonical: nearlink_sdr.phy.preamble.psk_preamble_symbols

```{autodoc2-docstring} nearlink_sdr.phy.preamble.psk_preamble_symbols
```
````