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

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

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

## Module Contents

### Functions

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

* - {py:obj}`sync_signal_1 <nearlink_sdr.phy.sync_sequence.sync_signal_1>`
  - ```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.sync_signal_1
    :summary:
    ```
* - {py:obj}`sync_signal_1_validate <nearlink_sdr.phy.sync_sequence.sync_signal_1_validate>`
  - ```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.sync_signal_1_validate
    :summary:
    ```
* - {py:obj}`sync_signal_2 <nearlink_sdr.phy.sync_sequence.sync_signal_2>`
  - ```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.sync_signal_2
    :summary:
    ```
* - {py:obj}`sync_signal_3 <nearlink_sdr.phy.sync_sequence.sync_signal_3>`
  - ```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.sync_signal_3
    :summary:
    ```
* - {py:obj}`sync_signal_4 <nearlink_sdr.phy.sync_sequence.sync_signal_4>`
  - ```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.sync_signal_4
    :summary:
    ```
* - {py:obj}`sync_signal_5 <nearlink_sdr.phy.sync_sequence.sync_signal_5>`
  - ```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.sync_signal_5
    :summary:
    ```
* - {py:obj}`sync_signal_6 <nearlink_sdr.phy.sync_sequence.sync_signal_6>`
  - ```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.sync_signal_6
    :summary:
    ```
````

### Data

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

* - {py:obj}`SYNC1_BROADCAST <nearlink_sdr.phy.sync_sequence.SYNC1_BROADCAST>`
  - ```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.SYNC1_BROADCAST
    :summary:
    ```
* - {py:obj}`SYNC2_BROADCAST <nearlink_sdr.phy.sync_sequence.SYNC2_BROADCAST>`
  - ```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.SYNC2_BROADCAST
    :summary:
    ```
````

### API

````{py:data} SYNC1_BROADCAST
:canonical: nearlink_sdr.phy.sync_sequence.SYNC1_BROADCAST
:value: >
   'array(...)'

```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.SYNC1_BROADCAST
```

````

````{py:data} SYNC2_BROADCAST
:canonical: nearlink_sdr.phy.sync_sequence.SYNC2_BROADCAST
:value: >
   'array(...)'

```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.SYNC2_BROADCAST
```

````

````{py:function} sync_signal_1(link_id_24: int | None = None) -> numpy.ndarray
:canonical: nearlink_sdr.phy.sync_sequence.sync_signal_1

```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.sync_signal_1
```
````

````{py:function} sync_signal_1_validate(sync_32: numpy.ndarray) -> bool
:canonical: nearlink_sdr.phy.sync_sequence.sync_signal_1_validate

```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.sync_signal_1_validate
```
````

````{py:function} sync_signal_2(link_id_24: int | None = None) -> numpy.ndarray
:canonical: nearlink_sdr.phy.sync_sequence.sync_signal_2

```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.sync_signal_2
```
````

````{py:function} sync_signal_3(m_seq_index: int = 0) -> numpy.ndarray
:canonical: nearlink_sdr.phy.sync_sequence.sync_signal_3

```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.sync_signal_3
```
````

````{py:function} sync_signal_4(m_seq_index: int = 0) -> numpy.ndarray
:canonical: nearlink_sdr.phy.sync_sequence.sync_signal_4

```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.sync_signal_4
```
````

````{py:function} sync_signal_5(seed: bytes, slot_number: int, n_sync: int = 32, is_tx: bool = True, kdf_type: int = 0) -> numpy.ndarray
:canonical: nearlink_sdr.phy.sync_sequence.sync_signal_5

```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.sync_signal_5
```
````

````{py:function} sync_signal_6(seed: bytes, slot_number: int, n_sync: int = 32, is_tx: bool = True, kdf_type: int = 0) -> numpy.ndarray
:canonical: nearlink_sdr.phy.sync_sequence.sync_signal_6

```{autodoc2-docstring} nearlink_sdr.phy.sync_sequence.sync_signal_6
```
````