Source code for seabreeze.pyseabreeze.features.multicast

import struct

from seabreeze.pyseabreeze.features._base import SeaBreezeFeature
from seabreeze.pyseabreeze.protocol import OBPProtocol


# Definition
# ==========
#
# TODO: This feature needs to be implemented for pyseabreeze
#


class SeaBreezeMulticastFeature(SeaBreezeFeature):
    identifier = "multicast"

    def get_multicast_enable_state(self, interface_index: int) -> bool:
        raise NotImplementedError("implement in derived class")

    def set_multicast_enable_state(
        self, interface_index: int, enable_state: bool
    ) -> None:
        raise NotImplementedError("implement in derived class")



# OBP implementation
# ==================
#
class SeaBreezeMulticastFeatureOBP(SeaBreezeMulticastFeature):
    _required_protocol_cls = OBPProtocol

    def get_multicast_enable_state(self, interface_index: int) -> bool:
        ret = self.protocol.query(0x00000A80, int(interface_index))
        return bool(struct.unpack("<B", ret))

    def set_multicast_enable_state(
        self, interface_index: int, enable_state: bool
    ) -> None:
        raise NotImplementedError("missing from HDX FW documentation")