aioads 0.1.0.dev1__tar.gz → 0.1.0.dev2__tar.gz

aioads-0.1.0.dev2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MkKiefer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{aioads-0.1.0.dev1 → aioads-0.1.0.dev2}/PKG-INFO

@@ -1,11 +1,15 @@
 Metadata-Version: 2.4
 Name: aioads
-Version: 0.1.0.dev1
+Version: 0.1.0.dev2
 Summary: An asynchronous Python library for communicating with Beckhoff TwinCAT PLCs
 Author-email: MkKiefer <102972583+MkKiefer@users.noreply.github.com>
 License: MIT
+License-File: LICENSE
 Requires-Python: >=3.12
-Requires-Dist: aiomqtt>=v3.0.0-alpha.1
+Provides-Extra: aiomqtt
+Requires-Dist: aiomqtt>=v3.0.0-alpha.1; extra == 'aiomqtt'
+Provides-Extra: gmqtt
+Requires-Dist: gmqtt>=0.7.0; extra == 'gmqtt'
 Description-Content-Type: text/markdown
 
 # AIOADS - Asynchronous ADS Library for Python
@@ -26,9 +30,18 @@ An asynchronous Python library for communicating with Beckhoff TwinCAT PLCs usin
 ## Installation
 
 ```bash
+# Ads TCP
 pdm add aioads
-
 pip install aioads
+
+# ADS over MQTT (gmqtt)
+pdm add aioads[gmqtt]
+pip install aioads[gmqtt]
+
+# Ads over MQTT (aiomqtt)
+pdm add aioads[aiomqtt]
+pip install aioads[aiomqtt]
+
 ```
 
 ## Quick Start
@@ -194,11 +207,11 @@ async def main():
 
 The library supports all major ADS commands:
 
-- **Read/Write Operations**: Single and batch symbol access
+- **Read/Write Operations**: Single and batch
 - **Device Information**: State, version, and device info
 - **Symbol Management**: Symbol table upload and parsing
 - **Data Types**: Complete data type information and parsing
-- **Notifications**: Change and cyclic notifications
+- **Notifications**: Change and cyclic notifications (Still in preview)
 - **Sum Commands**: Efficient bulk operations
 
 ### Data Types
@@ -210,75 +223,23 @@ Full support for TwinCAT data types:
 - **Complex Types**: Custom user-defined types
 - **Arrays**: Multi-dimensional arrays with proper indexing
 
-### Notification Modes
-
-Multiple notification transmission modes supported:
-
-| Mode                | Description                 | Use Case                |
-| ------------------- | --------------------------- | ----------------------- |
-| `ClientCycle`       | Client-triggered periodic   | Reduced server load     |
-| `ClientOnChange`    | Client-triggered on change  | Reduced server load     |
-| `Cyclic`            | Server-side periodic        | Real-time performance   |
-| `OnChange`          | Server-side on change       | Immediate notifications |
-| `CyclicInContext`   | Task-synchronized periodic  | Task coordination       |
-| `OnChangeInContext` | Task-synchronized on change | Task coordination       |
-
-## Project Structure
-
-```
-aioads/
-├── ads_client.py           # Main client interface
-├── tcp_transport.py        # TCP transport layer
-├── ads_symbol_cache.py     # Symbol caching system
-├── ads_symbol_parser.py    # Symbol data parsing
-├── ams_address.py          # AMS addressing
-├── ams_header.py           # AMS protocol headers
-├── commands/               # ADS command implementations
-│   ├── ads_read.py
-│   ├── ads_write.py
-│   ├── ads_read_state.py
-│   └── ...
-├── functions/              # ADS function implementations
-│   ├── ads_sum_read.py
-│   ├── ads_symbol_upload.py
-│   └── ...
-└── utils/                  # Utility functions
-    └── async_zip.py
-```
-
-## Examples
-
-Check the `examples/` directory for complete usage examples:
-
-- `read_cycles.py` - Basic single symbol reading
-- `read_multiple.py` - Batch reading
 
 ## Requirements
 
 - Python 3.11+
 - asyncio
-- No external dependencies (pure Python implementation)
-
-## Performance
+- aiomqtt (optional)
 
-The library is optimized for high-performance scenarios:
 
-- **Batch Operations**: Read multiple symbols in single ADS calls
-- **Smart Caching**: Symbol information cached to avoid repeated lookups
-- **Async Architecture**: Non-blocking I/O for maximum throughput
+## Disclaimer
 
-Typical performance:
-- Single symbol read: ~1-5ms
-- Batch reads (100+ symbols): ~10-50ms
+This project is an independent, open‑source implementation of the ADS (Automation Device Specification) protocol. It is not affiliated with, endorsed by, or supported by Beckhoff Automation GmbH & Co. KG, the developer of TwinCAT and the ADS protocol.
+All trademarks and product names are the property of their respective owners.
 
 ## License
 
 This project is licensed under the MIT License - see the LICENSE file for details.
 
-## Contributing
-
-Contributions are welcome! Please feel free to submit a Pull Request.
-
 ## Troubleshooting
 
 ### Connection Issues
@@ -291,12 +252,10 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 
 1. **PLC State**: Ensure PLC is in RUN mode for symbol access
 
-### Performance Issues
 
-1. **Batch Reads**: Use batch operations instead of individual reads
-2. **Caching**: Pre-load symbol info with `read_symbol_infos_by_names()`
-3. **Concurrent Tasks**: Be mindful of PLC load with multiple tasks
+## Contributing guidelines
 
-## Support
+AIOADS is a personal hobby project, developed and maintained in my spare time.
+While I aim to keep it functional and improve it over time, it may not always receive frequent updates, and features or bug fixes might take a while.
 
-For questions, issues, or contributions, please refer to the project's GitHub repository.
+If you rely on this library in production environments, consider reviewing the code, contributing improvements, or opening issues so the community can help keep it healthy.

{aioads-0.1.0.dev1 → aioads-0.1.0.dev2}/README.md

@@ -16,9 +16,18 @@ An asynchronous Python library for communicating with Beckhoff TwinCAT PLCs usin
 ## Installation
 
 ```bash
+# Ads TCP
 pdm add aioads
-
 pip install aioads
+
+# ADS over MQTT (gmqtt)
+pdm add aioads[gmqtt]
+pip install aioads[gmqtt]
+
+# Ads over MQTT (aiomqtt)
+pdm add aioads[aiomqtt]
+pip install aioads[aiomqtt]
+
 ```
 
 ## Quick Start
@@ -184,11 +193,11 @@ async def main():
 
 The library supports all major ADS commands:
 
-- **Read/Write Operations**: Single and batch symbol access
+- **Read/Write Operations**: Single and batch
 - **Device Information**: State, version, and device info
 - **Symbol Management**: Symbol table upload and parsing
 - **Data Types**: Complete data type information and parsing
-- **Notifications**: Change and cyclic notifications
+- **Notifications**: Change and cyclic notifications (Still in preview)
 - **Sum Commands**: Efficient bulk operations
 
 ### Data Types
@@ -200,75 +209,23 @@ Full support for TwinCAT data types:
 - **Complex Types**: Custom user-defined types
 - **Arrays**: Multi-dimensional arrays with proper indexing
 
-### Notification Modes
-
-Multiple notification transmission modes supported:
-
-| Mode                | Description                 | Use Case                |
-| ------------------- | --------------------------- | ----------------------- |
-| `ClientCycle`       | Client-triggered periodic   | Reduced server load     |
-| `ClientOnChange`    | Client-triggered on change  | Reduced server load     |
-| `Cyclic`            | Server-side periodic        | Real-time performance   |
-| `OnChange`          | Server-side on change       | Immediate notifications |
-| `CyclicInContext`   | Task-synchronized periodic  | Task coordination       |
-| `OnChangeInContext` | Task-synchronized on change | Task coordination       |
-
-## Project Structure
-
-```
-aioads/
-├── ads_client.py           # Main client interface
-├── tcp_transport.py        # TCP transport layer
-├── ads_symbol_cache.py     # Symbol caching system
-├── ads_symbol_parser.py    # Symbol data parsing
-├── ams_address.py          # AMS addressing
-├── ams_header.py           # AMS protocol headers
-├── commands/               # ADS command implementations
-│   ├── ads_read.py
-│   ├── ads_write.py
-│   ├── ads_read_state.py
-│   └── ...
-├── functions/              # ADS function implementations
-│   ├── ads_sum_read.py
-│   ├── ads_symbol_upload.py
-│   └── ...
-└── utils/                  # Utility functions
-    └── async_zip.py
-```
-
-## Examples
-
-Check the `examples/` directory for complete usage examples:
-
-- `read_cycles.py` - Basic single symbol reading
-- `read_multiple.py` - Batch reading
 
 ## Requirements
 
 - Python 3.11+
 - asyncio
-- No external dependencies (pure Python implementation)
-
-## Performance
+- aiomqtt (optional)
 
-The library is optimized for high-performance scenarios:
 
-- **Batch Operations**: Read multiple symbols in single ADS calls
-- **Smart Caching**: Symbol information cached to avoid repeated lookups
-- **Async Architecture**: Non-blocking I/O for maximum throughput
+## Disclaimer
 
-Typical performance:
-- Single symbol read: ~1-5ms
-- Batch reads (100+ symbols): ~10-50ms
+This project is an independent, open‑source implementation of the ADS (Automation Device Specification) protocol. It is not affiliated with, endorsed by, or supported by Beckhoff Automation GmbH & Co. KG, the developer of TwinCAT and the ADS protocol.
+All trademarks and product names are the property of their respective owners.
 
 ## License
 
 This project is licensed under the MIT License - see the LICENSE file for details.
 
-## Contributing
-
-Contributions are welcome! Please feel free to submit a Pull Request.
-
 ## Troubleshooting
 
 ### Connection Issues
@@ -281,12 +238,10 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 
 1. **PLC State**: Ensure PLC is in RUN mode for symbol access
 
-### Performance Issues
 
-1. **Batch Reads**: Use batch operations instead of individual reads
-2. **Caching**: Pre-load symbol info with `read_symbol_infos_by_names()`
-3. **Concurrent Tasks**: Be mindful of PLC load with multiple tasks
+## Contributing guidelines
 
-## Support
+AIOADS is a personal hobby project, developed and maintained in my spare time.
+While I aim to keep it functional and improve it over time, it may not always receive frequent updates, and features or bug fixes might take a while.
 
-For questions, issues, or contributions, please refer to the project's GitHub repository.
+If you rely on this library in production environments, consider reviewing the code, contributing improvements, or opening issues so the community can help keep it healthy.