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

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

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

## Module Contents

### Functions

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

* - {py:obj}`generate_m_sequence <nearlink_sdr.common.m_sequence.generate_m_sequence>`
  - ```{autodoc2-docstring} nearlink_sdr.common.m_sequence.generate_m_sequence
    :summary:
    ```
* - {py:obj}`m31_sequence <nearlink_sdr.common.m_sequence.m31_sequence>`
  - ```{autodoc2-docstring} nearlink_sdr.common.m_sequence.m31_sequence
    :summary:
    ```
* - {py:obj}`m63_sequence <nearlink_sdr.common.m_sequence.m63_sequence>`
  - ```{autodoc2-docstring} nearlink_sdr.common.m_sequence.m63_sequence
    :summary:
    ```
````

### Data

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

* - {py:obj}`M31_CONFIGS <nearlink_sdr.common.m_sequence.M31_CONFIGS>`
  - ```{autodoc2-docstring} nearlink_sdr.common.m_sequence.M31_CONFIGS
    :summary:
    ```
* - {py:obj}`M63_CONFIGS <nearlink_sdr.common.m_sequence.M63_CONFIGS>`
  - ```{autodoc2-docstring} nearlink_sdr.common.m_sequence.M63_CONFIGS
    :summary:
    ```
````

### API

````{py:data} M31_CONFIGS
:canonical: nearlink_sdr.common.m_sequence.M31_CONFIGS
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.common.m_sequence.M31_CONFIGS
```

````

````{py:data} M63_CONFIGS
:canonical: nearlink_sdr.common.m_sequence.M63_CONFIGS
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.common.m_sequence.M63_CONFIGS
```

````

````{py:function} generate_m_sequence(order: int, taps: int, init_val: int, length: int | None = None) -> numpy.ndarray
:canonical: nearlink_sdr.common.m_sequence.generate_m_sequence

```{autodoc2-docstring} nearlink_sdr.common.m_sequence.generate_m_sequence
```
````

````{py:function} m31_sequence(index: int, length: int = 31) -> numpy.ndarray
:canonical: nearlink_sdr.common.m_sequence.m31_sequence

```{autodoc2-docstring} nearlink_sdr.common.m_sequence.m31_sequence
```
````

````{py:function} m63_sequence(index: int, length: int = 63) -> numpy.ndarray
:canonical: nearlink_sdr.common.m_sequence.m63_sequence

```{autodoc2-docstring} nearlink_sdr.common.m_sequence.m63_sequence
```
````