ITQC/pydase
24
0
Fork 0
mirror of https://github.com/tiqi-group/pydase.git synced 2025-06-23 20:47:59 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: adds "Direct API Access" section to python-client.md

Browse Source
This commit is contained in:
Mose Müller
2025-06-19 13:54:52 +02:00
parent 43c6b5e817
commit f5374573cd
1 changed files with 20 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/user-guide/interaction/Python-Client.md
View File

@ -23,7 +23,26 @@ The proxy acts as a local representation of the remote service, enabling intuiti
The proxy class automatically synchronizes with the server's attributes and methods, keeping itself up-to-date with any changes. This dynamic synchronization essentially mirrors the server's API, making it feel like you're working with a local object. The proxy class automatically synchronizes with the server's attributes and methods, keeping itself up-to-date with any changes. This dynamic synchronization essentially mirrors the server's API, making it feel like you're working with a local object.
### Accessing Services Behind Firewalls or SSH Gateways ## Direct API Access
In addition to using the `proxy` object, users may access the server API directly via the following methods:
```python
client = pydase.Client(url="ws://localhost:8001")
# Get the current value of an attribute
value = client.get_value("device.voltage")
# Update an attribute
client.update_value("device.voltage", 5.0)
# Call a method on the remote service
result = client.trigger_method("device.reset")
```
This bypasses the proxy and is useful for lower-level access to individual service endpoints.
## Accessing Services Behind Firewalls or SSH Gateways
If your service is only reachable through a private network or SSH gateway, you can route your connection through a local SOCKS5 proxy using the `proxy_url` parameter. If your service is only reachable through a private network or SSH gateway, you can route your connection through a local SOCKS5 proxy using the `proxy_url` parameter.