ITQC/pydase
24
0
Fork 0
mirror of https://github.com/tiqi-group/pydase.git synced 2025-04-21 00:40:01 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: updates Readme

Browse Source 
Trying to clarify the usage of ports in both server and clients.
This commit is contained in:
Mose Müller 2024-09-17 07:23:00 +02:00
parent 9180bb1d9e
commit 4a09f02882
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -105,7 +105,7 @@ class Device(pydase.DataService):
if __name__ == "__main__": if __name__ == "__main__":
service = Device() service = Device()
pydase.Server(service=service).run() pydase.Server(service=service, web_port=8001).run()
``` ```
In the above example, we define a `Device` class that inherits from `pydase.DataService`. In the above example, we define a `Device` class that inherits from `pydase.DataService`.
@ -122,10 +122,13 @@ import pydase
if __name__ == "__main__": if __name__ == "__main__":
service = Device() service = Device()
pydase.Server(service=service).run() pydase.Server(service=service, web_port=8001).run()
``` ```
This will start the server, making your `Device` service accessible on [http://localhost:8001](http://localhost:8001). This will start the server, making your `Device` service accessible on
[http://localhost:8001](http://localhost:8001). The port number for the web server can
be customised in the server constructor or through environment variables and defaults
to `8001`.
### Accessing the Web Interface ### Accessing the Web Interface
@ -144,7 +147,7 @@ import pydase
# Replace the hostname and port with the IP address and the port of the machine where # Replace the hostname and port with the IP address and the port of the machine where
# the service is running, respectively # the service is running, respectively
client_proxy = pydase.Client(url="ws://<ip_addr>:<service_port>").proxy client_proxy = pydase.Client(url="ws://<ip_addr>:<web_port>").proxy
# client_proxy = pydase.Client(url="wss://your-domain.ch").proxy # if your service uses ssl-encryption # client_proxy = pydase.Client(url="wss://your-domain.ch").proxy # if your service uses ssl-encryption
# After the connection, interact with the service attributes as if they were local # After the connection, interact with the service attributes as if they were local
@ -170,7 +173,7 @@ import json
import requests import requests
response = requests.get( response = requests.get(
"http://<hostname>:<port>/api/v1/get_value?access_path=<full_access_path>" "http://<hostname>:<web_port>/api/v1/get_value?access_path=<full_access_path>"
) )
serialized_value = json.loads(response.text) serialized_value = json.loads(response.text)
``` ```