feat: adding ionizer_interface module

This commit is contained in:
Mose Mueller
2023-10-09 10:46:51 +02:00
parent 5f1e925c56
commit 2d7c7f9f1e
6 changed files with 977 additions and 300 deletions

View File

@@ -0,0 +1,35 @@
# Ionizer Interface
`IonizerServer` is a specialized server designed to extend `pydase` applications for seamless integration with the Ionizer system. By acting as a bridge between your `pydase` service and Ionizer, this server ensures that changes or events in your service are communicated betweeen pydase and Ionizer in real-time.
## How to Use
To deploy `IonizerServer` alongside your service, follow these steps:
```python
from icon_service_base.ionizer_interface import IonizerServer
class YourServiceClass:
# your implementation...
if __name__ == "__main__":
# Instantiate your service
service = YourServiceClass()
# Start the main pydase server with IonizerServer as an additional server
Server(
service,
additional_servers=[
{
"server": IonizerServer,
"port": 8002,
"kwargs": {},
}
],
).run()
```
This sets up your primary `pydase` server with `YourServiceClass` as the service. Additionally, it integrates the `IonizerServer` on port `8002`.
For further details, issues, or contributions, please refer to the [official documentation](https://pydase.readthedocs.io/en/latest/) or contact the maintainers.