# {py:mod}`nearlink_sdr.mac.frame`

```{py:module} nearlink_sdr.mac.frame
```

```{autodoc2-docstring} nearlink_sdr.mac.frame
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`AsyncDataFrame <nearlink_sdr.mac.frame.AsyncDataFrame>`
  - ```{autodoc2-docstring} nearlink_sdr.mac.frame.AsyncDataFrame
    :summary:
    ```
* - {py:obj}`ControlFrame <nearlink_sdr.mac.frame.ControlFrame>`
  - ```{autodoc2-docstring} nearlink_sdr.mac.frame.ControlFrame
    :summary:
    ```
* - {py:obj}`MuxFrame <nearlink_sdr.mac.frame.MuxFrame>`
  - ```{autodoc2-docstring} nearlink_sdr.mac.frame.MuxFrame
    :summary:
    ```
* - {py:obj}`SegmentType <nearlink_sdr.mac.frame.SegmentType>`
  - ```{autodoc2-docstring} nearlink_sdr.mac.frame.SegmentType
    :summary:
    ```
* - {py:obj}`SyncDataFrame <nearlink_sdr.mac.frame.SyncDataFrame>`
  - ```{autodoc2-docstring} nearlink_sdr.mac.frame.SyncDataFrame
    :summary:
    ```
````

### API

`````{py:class} AsyncDataFrame
:canonical: nearlink_sdr.mac.frame.AsyncDataFrame

```{autodoc2-docstring} nearlink_sdr.mac.frame.AsyncDataFrame
```

````{py:attribute} segment_type
:canonical: nearlink_sdr.mac.frame.AsyncDataFrame.segment_type
:type: int
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.mac.frame.AsyncDataFrame.segment_type
```

````

````{py:attribute} data
:canonical: nearlink_sdr.mac.frame.AsyncDataFrame.data
:type: bytes
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.mac.frame.AsyncDataFrame.data
```

````

````{py:method} pack() -> bytes
:canonical: nearlink_sdr.mac.frame.AsyncDataFrame.pack

```{autodoc2-docstring} nearlink_sdr.mac.frame.AsyncDataFrame.pack
```

````

````{py:method} unpack(data: bytes) -> nearlink_sdr.mac.frame.AsyncDataFrame
:canonical: nearlink_sdr.mac.frame.AsyncDataFrame.unpack
:classmethod:

```{autodoc2-docstring} nearlink_sdr.mac.frame.AsyncDataFrame.unpack
```

````

`````

`````{py:class} ControlFrame
:canonical: nearlink_sdr.mac.frame.ControlFrame

```{autodoc2-docstring} nearlink_sdr.mac.frame.ControlFrame
```

````{py:attribute} data_type_index
:canonical: nearlink_sdr.mac.frame.ControlFrame.data_type_index
:type: int
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.mac.frame.ControlFrame.data_type_index
```

````

````{py:attribute} payload
:canonical: nearlink_sdr.mac.frame.ControlFrame.payload
:type: bytes
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.mac.frame.ControlFrame.payload
```

````

````{py:method} pack() -> bytes
:canonical: nearlink_sdr.mac.frame.ControlFrame.pack

```{autodoc2-docstring} nearlink_sdr.mac.frame.ControlFrame.pack
```

````

````{py:method} unpack(data: bytes) -> tuple[nearlink_sdr.mac.frame.ControlFrame, int]
:canonical: nearlink_sdr.mac.frame.ControlFrame.unpack
:classmethod:

```{autodoc2-docstring} nearlink_sdr.mac.frame.ControlFrame.unpack
```

````

`````

`````{py:class} MuxFrame
:canonical: nearlink_sdr.mac.frame.MuxFrame

```{autodoc2-docstring} nearlink_sdr.mac.frame.MuxFrame
```

````{py:attribute} control_frames
:canonical: nearlink_sdr.mac.frame.MuxFrame.control_frames
:type: list[nearlink_sdr.mac.frame.ControlFrame]
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.mac.frame.MuxFrame.control_frames
```

````

````{py:attribute} data_frame
:canonical: nearlink_sdr.mac.frame.MuxFrame.data_frame
:type: nearlink_sdr.mac.frame.AsyncDataFrame | nearlink_sdr.mac.frame.SyncDataFrame | None
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.mac.frame.MuxFrame.data_frame
```

````

````{py:method} pack() -> bytes
:canonical: nearlink_sdr.mac.frame.MuxFrame.pack

```{autodoc2-docstring} nearlink_sdr.mac.frame.MuxFrame.pack
```

````

`````

`````{py:class} SegmentType()
:canonical: nearlink_sdr.mac.frame.SegmentType

Bases: {py:obj}`enum.IntEnum`

```{autodoc2-docstring} nearlink_sdr.mac.frame.SegmentType
```

```{rubric} Initialization
```

```{autodoc2-docstring} nearlink_sdr.mac.frame.SegmentType.__init__
```

````{py:attribute} COMPLETE
:canonical: nearlink_sdr.mac.frame.SegmentType.COMPLETE
:value: >
   0

```{autodoc2-docstring} nearlink_sdr.mac.frame.SegmentType.COMPLETE
```

````

````{py:attribute} FIRST
:canonical: nearlink_sdr.mac.frame.SegmentType.FIRST
:value: >
   1

```{autodoc2-docstring} nearlink_sdr.mac.frame.SegmentType.FIRST
```

````

````{py:attribute} MIDDLE
:canonical: nearlink_sdr.mac.frame.SegmentType.MIDDLE
:value: >
   2

```{autodoc2-docstring} nearlink_sdr.mac.frame.SegmentType.MIDDLE
```

````

````{py:attribute} LAST
:canonical: nearlink_sdr.mac.frame.SegmentType.LAST
:value: >
   3

```{autodoc2-docstring} nearlink_sdr.mac.frame.SegmentType.LAST
```

````

`````

`````{py:class} SyncDataFrame
:canonical: nearlink_sdr.mac.frame.SyncDataFrame

```{autodoc2-docstring} nearlink_sdr.mac.frame.SyncDataFrame
```

````{py:attribute} pdu_seq
:canonical: nearlink_sdr.mac.frame.SyncDataFrame.pdu_seq
:type: int
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.mac.frame.SyncDataFrame.pdu_seq
```

````

````{py:attribute} event_group
:canonical: nearlink_sdr.mac.frame.SyncDataFrame.event_group
:type: int
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.mac.frame.SyncDataFrame.event_group
```

````

````{py:attribute} frame_format
:canonical: nearlink_sdr.mac.frame.SyncDataFrame.frame_format
:type: int
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.mac.frame.SyncDataFrame.frame_format
```

````

````{py:attribute} segment_type
:canonical: nearlink_sdr.mac.frame.SyncDataFrame.segment_type
:type: int
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.mac.frame.SyncDataFrame.segment_type
```

````

````{py:attribute} data
:canonical: nearlink_sdr.mac.frame.SyncDataFrame.data
:type: bytes
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.mac.frame.SyncDataFrame.data
```

````

````{py:attribute} time_offset
:canonical: nearlink_sdr.mac.frame.SyncDataFrame.time_offset
:type: int | None
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.mac.frame.SyncDataFrame.time_offset
```

````

````{py:attribute} sdu_seq
:canonical: nearlink_sdr.mac.frame.SyncDataFrame.sdu_seq
:type: int | None
:value: >
   None

```{autodoc2-docstring} nearlink_sdr.mac.frame.SyncDataFrame.sdu_seq
```

````

````{py:method} pack() -> bytes
:canonical: nearlink_sdr.mac.frame.SyncDataFrame.pack

```{autodoc2-docstring} nearlink_sdr.mac.frame.SyncDataFrame.pack
```

````

````{py:method} unpack(data: bytes) -> nearlink_sdr.mac.frame.SyncDataFrame
:canonical: nearlink_sdr.mac.frame.SyncDataFrame.unpack
:classmethod:

```{autodoc2-docstring} nearlink_sdr.mac.frame.SyncDataFrame.unpack
```

````

`````