# {py:mod}`nearlink_sdr.common.scrambler`

```{py:module} nearlink_sdr.common.scrambler
```

```{autodoc2-docstring} nearlink_sdr.common.scrambler
:allowtitles:
```

## Module Contents

### Functions

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

* - {py:obj}`broadcast_seed <nearlink_sdr.common.scrambler.broadcast_seed>`
  - ```{autodoc2-docstring} nearlink_sdr.common.scrambler.broadcast_seed
    :summary:
    ```
* - {py:obj}`data_link_seed <nearlink_sdr.common.scrambler.data_link_seed>`
  - ```{autodoc2-docstring} nearlink_sdr.common.scrambler.data_link_seed
    :summary:
    ```
* - {py:obj}`descramble <nearlink_sdr.common.scrambler.descramble>`
  - ```{autodoc2-docstring} nearlink_sdr.common.scrambler.descramble
    :summary:
    ```
* - {py:obj}`scramble <nearlink_sdr.common.scrambler.scramble>`
  - ```{autodoc2-docstring} nearlink_sdr.common.scrambler.scramble
    :summary:
    ```
* - {py:obj}`scramble_sequence <nearlink_sdr.common.scrambler.scramble_sequence>`
  - ```{autodoc2-docstring} nearlink_sdr.common.scrambler.scramble_sequence
    :summary:
    ```
````

### API

````{py:function} broadcast_seed(physical_channel: int) -> int
:canonical: nearlink_sdr.common.scrambler.broadcast_seed

```{autodoc2-docstring} nearlink_sdr.common.scrambler.broadcast_seed
```
````

````{py:function} data_link_seed(slot_number: int) -> int
:canonical: nearlink_sdr.common.scrambler.data_link_seed

```{autodoc2-docstring} nearlink_sdr.common.scrambler.data_link_seed
```
````

````{py:function} descramble(bits: numpy.typing.NDArray[numpy.uint8], seed: int) -> numpy.typing.NDArray[numpy.uint8]
:canonical: nearlink_sdr.common.scrambler.descramble

```{autodoc2-docstring} nearlink_sdr.common.scrambler.descramble
```
````

````{py:function} scramble(bits: numpy.typing.NDArray[numpy.uint8], seed: int) -> numpy.typing.NDArray[numpy.uint8]
:canonical: nearlink_sdr.common.scrambler.scramble

```{autodoc2-docstring} nearlink_sdr.common.scrambler.scramble
```
````

````{py:function} scramble_sequence(length: int, seed: int) -> numpy.typing.NDArray[numpy.uint8]
:canonical: nearlink_sdr.common.scrambler.scramble_sequence

```{autodoc2-docstring} nearlink_sdr.common.scrambler.scramble_sequence
```
````