Skip to content

Commit 3e7c82d

Browse files
authored
Swap README diagram to static image. Prep for publish. (#16)
* Replace mermaid diagram with static image. Move old markdown code to assets. * Refactor project metadata: Update README field format in pyproject.toml and ensure version consistency in __init__.py
1 parent e2314ba commit 3e7c82d

5 files changed

Lines changed: 23 additions & 13 deletions

File tree

README.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -168,17 +168,9 @@ The following methods facilitate explicit connection management and low-level co
168168

169169
Below is a high-level diagram illustrating the architecture of the `armctl` library. This design emphasizes the careful templatization of connection and control APIs, ensuring a consistent and extensible interface across different manufacturers and robot series.
170170

171-
```mermaid
172-
flowchart TD
173-
CommTemplate["Communication Template"] --> SocketController["Socket Controller"] & PLCController["PLC Controller"] & SerialController["Serial Controller"]
174-
CtrlTemplate["Control Template"] --> Manufacturer1["Manufacturer (Socket-based)"] & Manufacturer2["Manufacturer (PLC-based)"] & Manufacturer3["Manufacturer (Serial-based)"]
175-
SocketController --> Manufacturer1
176-
PLCController --> Manufacturer2
177-
SerialController --> Manufacturer3
178-
Manufacturer2 --> Series2["Robot Series"]
179-
Manufacturer3 --> Series3["Robot Series"]
180-
Manufacturer1 --> n3["Robot Series"]
181-
```
171+
<p align="center">
172+
<img src="https://raw.githubusercontent.com/MGross21/armctl/main/assets/images/template_overview_mermaid.png" alt="Template Overview" width="800">
173+
</p>
182174

183175
### System Logging
184176

armctl/__init__.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
"Logger",
4141
]
4242

43+
__version__ = "0.3.0"
4344

4445
class Logger:
4546
"""Global logger utility for armctl."""
@@ -59,3 +60,8 @@ def enable():
5960

6061
# Re-enable logging to its previous state
6162
logging.disable(logging.NOTSET)
63+
64+
import os
65+
66+
if os.environ.get("ARMCTL_LOG") == "DISABLE":
67+
Logger.disable()
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Template Overview
2+
3+
```mermaid
4+
flowchart TD
5+
CommTemplate["Communication Template"] --> SocketController["Socket Controller"] & PLCController["PLC Controller"] & SerialController["Serial Controller"]
6+
CtrlTemplate["Control Template"] --> Manufacturer1["Manufacturer (Socket-based)"] & Manufacturer2["Manufacturer (PLC-based)"] & Manufacturer3["Manufacturer (Serial-based)"]
7+
SocketController --> Manufacturer1
8+
PLCController --> Manufacturer2
9+
SerialController --> Manufacturer3
10+
Manufacturer2 --> Series2["Robot Series"]
11+
Manufacturer3 --> Series3["Robot Series"]
12+
Manufacturer1 --> n3["Robot Series"]
13+
```
190 KB
Loading

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ build-backend = "poetry.core.masonry.api"
66
name = "armctl"
77
version = "0.3.0"
88
description = "Agnostic Robotic Manipulator Controller"
9-
packages = [{ include = "armctl" }]
109
authors = [{ name = "Michael Gross", email = "MGross21@TODO.com" }]
11-
readme = "README.md"
10+
readme = {file = "README.md", content-type = "text/markdown"}
1211
license = { file = "LICENSE" }
1312
keywords = ["robotics", "socket", "control", "automation"]
1413
classifiers = [

0 commit comments

Comments
 (0)