UML updates

noelanderson · Jan 24, 2025 · d731ebf · d731ebf
1 parent 3268017
commit d731ebf
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/README.rst b/README.rst
@@ -108,10 +108,13 @@ Usage Example
 
 Documentation
 =============
-API documentation for this library can be found on `Read the Docs <https://circuitpython-as5600.readthedocs.io/>`_.
 
-For information on building library documentation, please check out
-`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
+Class Diagram for library
+
+.. figure:: https://raw.githubusercontent.com/noelanderson/CircuitPython_AS5600/master/uml/as5600.svg
+   :alt: Class Diagram
+
+API documentation for this library can be found on `Read the Docs <https://circuitpython-as5600.readthedocs.io/>`_.
 
 Contributing
 ============

diff --git a/uml/as5600.puml b/uml/as5600.puml
@@ -2,6 +2,7 @@
 ' SPDX-License-Identifier: MIT
 
 @startuml AS5600
+
 class AS5600 {
     + AS5600 (i2c : I2C, address : int)
     ..
@@ -75,6 +76,11 @@ enum FastFilterThreshold {
     FAST_FILTER_THRESHOLD_10LSB : int = 7
 }
 
+'force layout
+PWMFrequency-[hidden]--> SlowFilter
+PWMFrequency-[hidden]--> FastFilterThreshold
+PowerMode-[hidden]--> Hysteresis
+
 AS5600 -- PowerMode
 AS5600 -- Hysteresis
 AS5600 -- OutputStage