Update documentation with image

Added image to clearify how PyStageLinQ is used.
Also updated the readthedocs config files.

Author: Jaxc

docs/PyStageLinQflow.md

@@ -0,0 +1,4 @@
+# PyStageLinQ call flow
+The following picture shows the intended way to interact with Statemap using PyStageLinQ:
+
+![PyStageLinQ usage flowchart](charts/PyStageLinQ usage flowchart.png)

docs/charts/PyStageLinQ internal flow.graphml

@@ -19,11 +19,11 @@
 # -- Project information -----------------------------------------------------
 
 project = "PyStageLinQ"
-copyright = "2022, Jaxcie"
+copyright = "2024, Jaxcie"
 author = "Jaxcie"
 
 # The full version, including alpha/beta/rc tags
-release = "0.1.0"
+release = "0.0.0"
 
 # -- General configuration ---------------------------------------------------
 

docs/charts/PyStageLinQ internal flow.png

@@ -0,0 +1,51 @@
+PyStageLinQ is a Python library for ineracting with StageLinQ devices over IP. It is distributed over PyPi and currently
+supports the StateMap functionality.
+
+# Installation
+`pip install PyStageLinQ`
+
+# Example usage
+Here follow an example of how PyStageLinQ can be used:
+
+```python
+from PyStageLinQ import EngineServices, PyStageLinQ
+PrimeGo = None
+
+# Callback for when PyStageLinQ as found a StageLinQ device. This will print out information about the found device
+# and if lets the user decide if they want to subscribe to a service or not.
+
+def new_device_found_callback(ip, discovery_frame, service_list):
+    # Print device info and supplied services
+    print(
+        f"Found new Device on ip {ip}: Device name: {discovery_frame.device_name}, ConnectionType: {discovery_frame.connection_type}, SwName: {discovery_frame.sw_name}, "
+        f"SwVersion: {discovery_frame.sw_version}, port: {discovery_frame.Port}")
+
+    if len(service_list) > 0:
+        print("Services found in device:")
+    else:
+        print("No services found")
+
+    for service in service_list:
+         print(f"\t{service.service} on port {service.port}")
+
+
+    # Request StateMap service
+    for service in service_list:
+        if service.service == "StateMap":
+            PrimeGo.subscribe_to_statemap(service, EngineServices.prime_go, state_map_data_print)
+
+
+# Callback for when data has arrived from a StageLinQ device. It is up to the user what to do with this information.
+
+def state_map_data_print(data):
+    for message in data:
+        print(message)
+
+# Example main function, starting PyStageLinQ.
+if __name__ == "__main__":
+    global PrimeGo
+
+    # Run PyStageLinQ on all available network interfaces
+    PrimeGo = PyStageLinQ.PyStageLinQ(new_device_found_callback, name="Jaxcie StagelinQ")
+    PrimeGo.start()
+```

docs/charts/PyStageLinQ usage flowchart.graphml

@@ -1,6 +1,11 @@
 Quickstart
 ************
 
+.. include:: quickstart.md
+   :parser: myst_parser.sphinx_
+
 .. include:: ../README.md
    :parser: myst_parser.sphinx_
 
+
+

docs/charts/PyStageLinQ usage flowchart.png

@@ -8,6 +8,7 @@ echo "Version detected from git tag: $new_ver"
 
 echo "Updating pyproject.toml"
 sed -i 's/version = "0.0.0"/version = "'$new_ver'"/' pyproject.toml
+sed -i 's/release = "0.0.0"/release = "'$new_ver'"/' docs/conf.py
 
 
 rm dist/* -f