tdl-xoa-driver 1.0.0b1__py3-none-any.whl

xoa_driver/internals/commands/pt_commands.py

@@ -0,0 +1,370 @@
+from __future__ import annotations
+from dataclasses import dataclass
+import typing
+
+from xoa_driver.internals.core.builders import (
+    build_get_request,
+    build_set_request
+)
+from xoa_driver.internals.core import interfaces
+from xoa_driver.internals.core.token import Token
+from xoa_driver.internals.core.transporter.registry import register_command
+from xoa_driver.internals.core.transporter.protocol.payload import (
+    field,
+    RequestBodyStruct,
+    ResponseBodyStruct,
+    XmpLong,
+    XmpSequence,
+)
+
+
+@register_command
+@dataclass
+class PT_TOTAL:
+    """
+    Obtains statistics concerning all the packets transmitted on a port.
+    """
+
+    code: typing.ClassVar[int] = 230
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        bit_count_last_sec: int = field(XmpLong())
+        """long integer, number of bits transmitted in the last second."""
+        packet_count_last_sec: int = field(XmpLong())
+        """long integer, number of packets transmitted in the last second."""
+        byte_count_since_cleared: int = field(XmpLong())
+        """long integer, number of bytes transmitted since statistics were cleared."""
+        packet_count_since_cleared: int = field(XmpLong())
+        """long integer, number of packets transmitted since statistics were cleared."""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get statistics concerning all the packets transmitted on a port.
+
+        :return: number of bits transmitted in the last second, number of packets transmitted in the last second,
+            number of bytes transmitted since statistics were cleared, and number of packets transmitted since statistics were cleared.
+        :rtype: PT_TOTAL.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port))
+
+
+@register_command
+@dataclass
+class PT_NOTPLD:
+    """
+    Obtains statistics concerning the packets without a test payload transmitted on
+    a port.
+    """
+
+    code: typing.ClassVar[int] = 231
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        bit_count_last_sec: int = field(XmpLong())
+        """long integer, number of bits transmitted in the last second."""
+        packet_count_last_sec: int = field(XmpLong())
+        """long integer, number of packets transmitted in the last second."""
+        byte_count_since_cleared: int = field(XmpLong())
+        """long integer, number of bytes transmitted since statistics were cleared."""
+        packet_count_since_cleared: int = field(XmpLong())
+        """long integer, number of packets transmitted since statistics were cleared."""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get statistics concerning the packets without a test payload transmitted on a port.
+
+        :return: number of bits transmitted in the last second, number of packets transmitted in the last second,
+            number of bytes transmitted since statistics were cleared, and number of packets transmitted since statistics were cleared
+        :rtype: PT_NOTPLD.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port))
+
+
+@register_command
+@dataclass
+class PT_STREAM:
+    """
+    Obtains statistics concerning the packets of a specific stream transmitted on a
+    port.
+    """
+
+    code: typing.ClassVar[int] = 232
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+    _stream_xindex: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        bit_count_last_sec: int = field(XmpLong())
+        """long integer, number of bits transmitted in the last second."""
+        packet_count_last_sec: int = field(XmpLong())
+        """long integer, number of packets transmitted in the last second."""
+        byte_count_since_cleared: int = field(XmpLong())
+        """long integer, number of bytes transmitted since statistics were cleared."""
+        packet_count_since_cleared: int = field(XmpLong())
+        """long integer, number of packets transmitted since statistics were cleared."""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get statistics concerning the packets of a specific stream transmitted on a port.
+
+        :return: number of bits transmitted in the last second, number of packets transmitted in the last second,
+            number of bytes transmitted since statistics were cleared, and number of packets transmitted since statistics were cleared.
+        :rtype: PT_STREAM.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port, indices=[self._stream_xindex]))
+
+
+@register_command
+@dataclass
+class PT_CLEAR:
+    """
+    Clear all the transmit statistics for a port. The byte and packet counts will
+    restart at zero.
+    """
+
+    code: typing.ClassVar[int] = 233
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+
+    class SetDataAttr(RequestBodyStruct):
+        pass
+
+    def set(self) -> Token[None]:
+        """Clear all the transmit statistics for a port. The byte and packet counts will restart at zero.
+        """
+
+        return Token(self._connection, build_set_request(self, module=self._module, port=self._port))
+
+
+@register_command
+@dataclass
+class PT_EXTRA:
+    """
+    Obtains additional statistics for packets transmitted on a port.
+    """
+
+    code: typing.ClassVar[int] = 235
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        tx_arp_req_count: typing.List[int] = field(XmpSequence(types_chunk=[XmpLong()]))
+        """long integer, number of ARP requests transmitted"""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get additional statistics for packets transmitted on a port.
+
+        :return: number of ARP requests transmitted
+        :rtype: PT_EXTRA.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port))
+
+
+@register_command
+@dataclass
+class PT_TOTALEXT:
+    """
+    .. versionadded: v1.1
+
+    An extension to :class:`PT_TOTAL` that also includes a calculation of bytes transmitted in the last second.
+    It returns list of long integers; this list may be expanded in future software releases.
+    """
+
+    code: typing.ClassVar[int] = 236
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        bit_count_last_sec: int = field(XmpLong())
+        """long integer, number of bits transmitted in the last second."""
+        byte_count_last_sec: int = field(XmpLong())
+        """long integer, number of bytes transmitted in the last second."""
+        packet_count_last_sec: int = field(XmpLong())
+        """long integer, number of packets transmitted in the last second."""
+        byte_count_since_cleared: int = field(XmpLong())
+        """long integer, number of bytes transmitted since statistics were cleared."""
+        packet_count_since_cleared: int = field(XmpLong())
+        """long integer, number of packets transmitted since statistics were cleared."""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get statistics concerning all the packets transmitted on a port.
+
+        :return: number of bits transmitted in the last second, number of bytes transmitted in the last second,
+            number of packets transmitted in the last second, number of bytes transmitted since statistics were cleared,
+            and number of packets transmitted since statistics were cleared.
+        :rtype: PT_TOTALEXT.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port))
+
+
+@register_command
+@dataclass
+class PT_NOTPLDEXT:
+    """
+    .. versionadded: v1.1
+
+    An extension to :class:`PT_NOTPLD` that also includes a calculation of bytes transmitted in the last second.
+    It returns list of long integers; this list may be expanded in future software releases.
+    """
+
+    code: typing.ClassVar[int] = 237
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        bit_count_last_sec: int = field(XmpLong())
+        """long integer, number of bits transmitted in the last second."""
+        byte_count_last_sec: int = field(XmpLong())
+        """long integer, number of bytes transmitted in the last second."""
+        packet_count_last_sec: int = field(XmpLong())
+        """long integer, number of packets transmitted in the last second."""
+        byte_count_since_cleared: int = field(XmpLong())
+        """long integer, number of bytes transmitted since statistics were cleared."""
+        packet_count_since_cleared: int = field(XmpLong())
+        """long integer, number of packets transmitted since statistics were cleared."""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get statistics concerning the packets without a test payload transmitted on a port.
+
+        :return: number of bits transmitted in the last second, number of bytes transmitted in the last second,
+            number of packets transmitted in the last second, number of bytes transmitted since statistics were cleared,
+            and number of packets transmitted since statistics were cleared
+        :rtype: PT_NOTPLDEXT.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port))
+
+
+@register_command
+@dataclass
+class PT_STREAMEXT:
+    """
+    .. versionadded: v1.1
+
+    An extension to :class:`PT_STREAM` that also includes a calculation of bytes transmitted in the last second.
+    It returns list of long integers; this list may be expanded in future software releases.
+    """
+
+    code: typing.ClassVar[int] = 238
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+    _stream_xindex: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        bit_count_last_sec: int = field(XmpLong())
+        """long integer, number of bits transmitted in the last second."""
+        byte_count_last_sec: int = field(XmpLong())
+        """long integer, number of bytes transmitted in the last second."""
+        packet_count_last_sec: int = field(XmpLong())
+        """long integer, number of packets transmitted in the last second."""
+        byte_count_since_cleared: int = field(XmpLong())
+        """long integer, number of bytes transmitted since statistics were cleared."""
+        packet_count_since_cleared: int = field(XmpLong())
+        """long integer, number of packets transmitted since statistics were cleared."""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get statistics concerning the packets of a specific stream transmitted on a port.
+
+        :return: number of bits transmitted in the last second, number of bytes transmitted in the last second,
+            number of packets transmitted in the last second, number of bytes transmitted since statistics were cleared,
+            and number of packets transmitted since statistics were cleared.
+        :rtype: PT_STREAMEXT.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port, indices=[self._stream_xindex]))
+
+
+@register_command
+@dataclass
+class PT_FLOWTOTAL:
+    """
+    Obtains statistics concerning all the packets transmitted from a between this
+    receive port and its partner TX port.
+    """
+
+    code: typing.ClassVar[int] = 1740
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+    _flow_xindex: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        l2_bps: int = field(XmpLong())
+        """long integer, number of bits transmitted at layer 2 in the last second for the flow."""
+        pps: int = field(XmpLong())
+        """long integer, number of packets transmitted in the last second for the flow."""
+        byte_count: int = field(XmpLong())
+        """long integer, number of bytes transmitted since statistics were cleared for the flow."""
+        packet_count: int = field(XmpLong())
+        """long integer, number of packets transmitted since statistics were cleared for the flow."""
+
+    def get(self) -> Token[GetDataAttr]:
+        """(Chimera only) Get statistics concerning all the packets transmitted from a between this receive port and its partner TX port.
+
+        :return:
+            number of bits transmitted at layer 2 in the last second for the flow,
+            number of packets transmitted in the last second for the flow,
+            number of bytes transmitted since statistics were cleared for the flow,
+            number of packets transmitted since statistics were cleared for the flow
+
+        :rtype: PT_FLOWTOTAL.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port, indices=[self._flow_xindex]))
+
+
+@register_command
+@dataclass
+class PT_FLOWCLEAR:
+    """
+    Clear all the transmit statistics on a particular flow for a Chimera port. The
+    byte and packet counts will restart at zero.
+    """
+
+    code: typing.ClassVar[int] = 1742
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+    _flow_xindex: int
+
+    class SetDataAttr(RequestBodyStruct):
+        pass
+
+    def set(self) -> Token[None]:
+        """(Chimera only) Clear all the transmit statistics on a particular flow for a Chimera port. The byte and packet counts will restart at zero.
+        """
+
+        return Token(self._connection, build_set_request(self, module=self._module, port=self._port, indices=[self._flow_xindex]))

xoa_driver/internals/commands/px_commands.py

@@ -0,0 +1,303 @@
+from __future__ import annotations
+from dataclasses import dataclass
+import typing
+
+from xoa_driver.internals.core.builders import (
+    build_get_request,
+    build_set_request
+)
+from xoa_driver.internals.core import interfaces
+from xoa_driver.internals.core.token import Token
+from xoa_driver.internals.core.transporter.registry import register_command
+from xoa_driver.internals.core.transporter.protocol.payload import (
+    field,
+    RequestBodyStruct,
+    ResponseBodyStruct,
+    XmpByte,
+    XmpHex,
+    XmpSequence,
+    XmpInt,
+    Hex,
+)
+
+
+@register_command
+@dataclass
+class PX_RW:
+    """
+    Provides read and write access to the register interface supported by the port transceiver. It is possible to both read and write register values.
+    """
+
+    code: typing.ClassVar[int] = 501
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+    _page_xindex: int
+    _register_xaddress: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        value: Hex = field(XmpHex(size=4))
+        """4 hex bytes, register value of the port transceiver"""
+
+    class SetDataAttr(RequestBodyStruct):
+        value: Hex = field(XmpHex(size=4))
+        """4 hex bytes, register value of the port transceiver"""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get the register value of a transceiver.
+
+        :return: the register value of a transceiver
+        :rtype: PX_RW.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port, indices=[self._page_xindex, self._register_xaddress]))
+
+    def set(self, value: Hex) -> Token[None]:
+        """Set the register value of a transceiver.
+
+        :param value: register value of a transceiver
+        :type value: Hex
+        """
+
+        return Token(self._connection, build_set_request(self, module=self._module, port=self._port, indices=[self._page_xindex, self._register_xaddress], value=value))
+
+
+@register_command
+@dataclass
+class PX_RW_SEQ:
+    """
+    I2C sequential access to a transceiver's register. When invoked, the <byte_count> number of bytes will be read or written in one I2C transaction, in which the <value> is read or written with only a single register address setup. A subsequent invocation will perform a second I2C transaction in the same manner.
+
+    * <_byte_xcount> number of bytes will be read or written in one I2C transaction
+
+    * <_page_xindex>: the transceiver page address, integer, 0x00 - 0xFF (0-255).
+
+    * <_register_xaddress>: the address within the page, integer, 0x00 - 0xFF (0-255).
+
+    If <_register_xaddress> < 128, the page index <_page_xindex> is ignored by the server. The server will read from page 0 without writing 0 into byte 127.
+
+    If <_register_xaddress> >=128, the page index <_page_xindex> will be written into byte 127.
+    """
+
+    code: typing.ClassVar[int] = 503
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+    _page_xindex: int
+    _register_xaddress: int
+    _byte_xcount: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        value: Hex = field(XmpHex())
+        """the bytes to be read or written in one I2C transaction. The number of bytes in the ``<value>`` equals ``<byte_count>``."""
+
+    class SetDataAttr(RequestBodyStruct):
+        value: Hex = field(XmpHex())
+        """the bytes to be read or written in one I2C transaction. The number of bytes in the ``<value>`` equals ``<byte_count>``."""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get the register value of a transceiver in one I2C transaction.
+
+        :return: the register value of a transceiver
+        :rtype: PX_RW_SEQ.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port, indices=[self._page_xindex, self._register_xaddress, self._byte_xcount]))
+
+    def set(self, value: Hex) -> Token[None]:
+        """Set the register value of a transceiver in one I2C transaction.
+
+        :param value: register value of a transceiver
+        :type value: Hex
+        """
+
+        return Token(
+            self._connection,
+            build_set_request(
+                self,
+                module=self._module,
+                port=self._port,
+                indices=[self._page_xindex, self._register_xaddress, self._byte_xcount],
+                value=value
+            )
+        )
+
+
+@register_command
+@dataclass
+class PX_RW_SEQ_BANK:
+    """
+    I2C sequential access to a transceiver's register. When invoked, the <byte_count> number of bytes will be read or written in one I2C transaction, in which the <value> is read or written with only a single register address setup. A subsequent invocation will perform a second I2C transaction in the same manner.
+
+    * <_bank_xindex>: the bank address, integer, 0x00 - 0xFF (0-255).
+
+    * <_page_xindex>: the transceiver page address, integer, 0x00 - 0xFF (0-255).
+
+    * <_register_xaddress>: the address within the page, integer, 0x00 - 0xFF (0-255).
+
+    * <_byte_xcount> number of bytes will be read or written in one I2C transaction
+
+    If <_register_xaddress> < 128, the page index <page> and the bank index <_bank_xindex> is ignored by the server. The server will read from page 0 without writing 0 into byte 127.
+
+    If <_register_xaddress> >=128, the page index <page> will be written into byte 127, and the bank index <_bank_xindex> will be written into byte 126.
+    """
+
+    code: typing.ClassVar[int] = 504
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+    _bank_xindex: int
+    _page_xindex: int
+    _register_xaddress: int
+    _byte_xcount: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        value: Hex = field(XmpHex())
+        """the bytes to be read or written in one I2C transaction. The number of bytes in the ``<value>`` equals ``<byte_count>``."""
+
+    class SetDataAttr(RequestBodyStruct):
+        value: Hex = field(XmpHex())
+        """the bytes to be read or written in one I2C transaction. The number of bytes in the ``<value>`` equals ``<byte_count>``."""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get the register value of a transceiver in one I2C transaction.
+
+        :return: the register value of a transceiver
+        :rtype: PX_RW_SEQ.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port, indices=[self._bank_xindex, self._page_xindex, self._register_xaddress, self._byte_xcount]))
+
+    def set(self, value: Hex) -> Token[None]:
+        """Set the register value of a transceiver in one I2C transaction.
+
+        :param value: register value of a transceiver
+        :type value: Hex
+        """
+
+        return Token(
+            self._connection,
+            build_set_request(
+                self,
+                module=self._module,
+                port=self._port,
+                indices=[self._bank_xindex, self._page_xindex, self._register_xaddress, self._byte_xcount],
+                value=value
+            )
+        )
+
+@register_command
+@dataclass
+class PX_MII:
+    """Provides access to the register interface supported by the media-independent interface (MII) transceiver. It
+    is possible to both read and write register values."""
+
+    code: typing.ClassVar[int] = 537
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+    _register_xaddress: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        value: Hex = field(XmpHex(size=2))
+        """2 hex bytes, register value of the transceiver"""
+
+    class SetDataAttr(RequestBodyStruct):
+        value: Hex = field(XmpHex(size=2))
+        """2 hex bytes, register value of the transceiver"""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get the register value of a transceiver.
+
+        :return: the register value of a transceiver
+        :rtype: PX_MII.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port, indices=[self._register_xaddress]))
+
+    def set(self, value: Hex) -> Token[None]:
+        """Set the register value of a transceiver.
+
+        :param value: register value of a transceiver
+        :type value: Hex
+        """
+
+        return Token(self._connection, build_set_request(self, module=self._module, port=self._port, indices=[self._register_xaddress], value=value))
+
+
+@register_command
+@dataclass
+class PX_TEMPERATURE:
+    """
+    Transceiver temperature in degrees Celsius.
+    """
+
+    code: typing.ClassVar[int] = 538
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        integral_part: int = field(XmpByte())
+        """byte, temperature value before the decimal digit."""
+        fractional_part: int = field(XmpByte())
+        """byte, 1/256th of a degree Celsius after the decimal digit."""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get transceiver temperature in degrees Celsius.
+
+        :return: temperature value before the decimal digit, and 1/256th of a degree Celsius after the decimal digit.
+        :rtype: PX_TEMPERATURE.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port))
+
+@register_command
+@dataclass
+class PX_I2C_CONFIG:
+    """
+    Set the get the access speed on a transceiver I2C access in the unit of KHz. Default to 100. When the transceiver is plugged out and in again, the speed will be reset to the default value 100. The speed has a minimum and a maximum, which can be obtained from P_CAPABILITIES. The I2C speed configuration will not be included in the port configuration file (.xpc). When you load a port configuration to a port, the transceiver I2C access speed will be reset to default 100.
+    """
+
+    code: typing.ClassVar[int] = 539
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+    _port: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        frequency: int = field(XmpInt())
+        """integer, frequency in kHz, default is 100."""
+    
+    class SetDataAttr(RequestBodyStruct):
+        frequency: int = field(XmpInt())
+        """integer, frequency in kHz, default is 100."""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get the speed on a transceiver I2C access in the unit of KHz.
+
+        :return: frequency in kHz.
+        :rtype: PX_I2C_CONFIG.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module, port=self._port))
+    
+    def set(self, frequency: int) -> Token[None]:
+        """Set the speed on a transceiver I2C access in the unit of KHz.
+
+        :param frequency: frequency in kHz
+        :type frequency: int
+        """
+
+        return Token(self._connection, build_set_request(self, module=self._module, port=self._port, frequency=frequency))