Prepare for release 0.2.3

---

+ Add documentation for newly added classes
+ Add changelog

Author: MatrixEditor

docs/source/changelog.rst

@@ -0,0 +1,17 @@
+.. _changelog:
+
+=========
+Changelog
+=========
+
+.. _v0.2.3:
+
+v0.2.3 :bdg-info:`beta-develop`
+----------------------------------
+
+**Added**
+
+- New :class:`~icspacket.proto.iec61850.goose.GOOSE_Client` and :class:`~icspacket.proto.iec61850.sv.SV_Client`
+- New :class:`~icspacket.proto.mms.data.Timestamp` to convert MMS UtcTime values into :class:`datetime`
+  objects.
+- Example to receive published GOOSE messages: ``gooseobserv.py``

docs/source/conf.py

@@ -72,7 +72,7 @@
     "color_mode": "dark",
     "github_url": "https://github.com/MatrixEditor/icspacket",
     "discussion_url": "https://github.com/MatrixEditor/icspacket/discussions",
-    "globaltoc_expand_depth": 2,
+    "globaltoc_expand_depth": 1,
     "toctree_maxdepth": 5,
     "nav_links": [
         {
@@ -96,5 +96,9 @@
                 }
             ],
         },
+        {
+            "title": "Changelog",
+            "url": "changelog",
+        }
     ],
 }

docs/source/index.rst

@@ -96,4 +96,10 @@ and MacOS. Any other Python version is not officially supported::
     :hidden:
 
     protocols/tpkt/usage
-    protocols/tpkt/api
+    protocols/tpkt/api
+
+
+.. toctree::
+    :caption: Development
+
+    changelog

docs/source/protocols/iec61850/api.rst

@@ -9,3 +9,5 @@ API Reference
     api_data_classes
     api_path
     api_client
+    api_goose
+    api_sv

docs/source/protocols/iec61850/api_goose.rst

@@ -0,0 +1,8 @@
+.. _iec61850_goose_api:
+
+GOOSE Client
+============
+
+
+.. automodule:: icspacket.proto.iec61850.goose
+    :members:

docs/source/protocols/iec61850/api_sv.rst

@@ -0,0 +1,8 @@
+.. _iec61850_sv_api:
+
+SampledValues Client
+====================
+
+
+.. automodule:: icspacket.proto.iec61850.sv
+    :members:

src/icspacket/proto/iec61850/goose.py

@@ -156,6 +156,8 @@ class GOOSE_Client:
         Publishing can be done **without** a sniffer running in the background,
         i.e. the with statement can be ignored.
 
+    .. versionadded:: 0.2.3
+
     :param iface:
         Optional capture interface or list of interfaces to sniff on.
         If multiple interfaces are provided, publishing requires

src/icspacket/proto/iec61850/sv.py

@@ -52,10 +52,8 @@ class SV_Client(GOOSE_Client):
     - **Compatibility:** Since SV reuses the same PDU decoding layer,
       both online capture and offline PCAP file analysis are supported.
 
-    Example
-    -------
-
     .. code-block:: python
+        :caption: Example
 
         # Capture Sampled Values on eth1
         with SV_Client(interfaces=["eth1"]) as sv_client:
@@ -66,6 +64,8 @@ class SV_Client(GOOSE_Client):
         sv_client = SV_Client(["eth1"])
         sv_client.publish("01:0c:cd:01:00:01", my_sv_apdu)
 
+    .. versionadded:: 0.2.3
+
     :param interfaces:
         List of interface names (e.g., ``["eth0", "eth1"]``) to capture
         and/or publish Sampled Values on. If ``None``, the default system

src/icspacket/proto/mms/data.py

@@ -141,7 +141,10 @@ def get_floating_point_value(fp: FloatingPoint | bytes) -> float:
 
 @bitfield(order=BigEndian, options=[S_ADD_BYTES])
 class Timestamp:
-    """Structured bitfield representation of a timestamp value."""
+    """Structured bitfield representation of a timestamp value.
+
+    .. versionadded:: 0.2.3
+    """
 
     timeval: Bytes(4) = bytes(4)
     """4-byte unsigned integer representing the elapsed time in seconds."""