mirror of
https://github.com/tiqi-group/pydase.git
synced 2025-04-20 08:20:02 +02:00
docs: updating readme
This commit is contained in:
parent
ee124ead89
commit
2ce8ace227
24
README.md
24
README.md
@ -52,48 +52,54 @@ To use pydase, you'll first need to create a class that inherits from `DataServi
|
|||||||
Here's an example:
|
Here's an example:
|
||||||
|
|
||||||
```python
|
```python
|
||||||
from pydase import DataService
|
from pydase import DataService, Server
|
||||||
|
|
||||||
|
|
||||||
class Device(DataService):
|
class Device(DataService):
|
||||||
|
|
||||||
_current = 0.0
|
_current = 0.0
|
||||||
_voltage = 0.0
|
_voltage = 0.0
|
||||||
_power = False
|
_power = False
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def current(self):
|
def current(self) -> float:
|
||||||
# run code to get current
|
# run code to get current
|
||||||
return self._current
|
return self._current
|
||||||
|
|
||||||
@current.setter
|
@current.setter
|
||||||
def current(self, value):
|
def current(self, value: float) -> None:
|
||||||
# run code to set current
|
# run code to set current
|
||||||
self._current = value
|
self._current = value
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def voltage(self):
|
def voltage(self) -> float:
|
||||||
# run code to get voltage
|
# run code to get voltage
|
||||||
return self._voltage
|
return self._voltage
|
||||||
|
|
||||||
@voltage.setter
|
@voltage.setter
|
||||||
def voltage(self, value):
|
def voltage(self, value: float) -> None:
|
||||||
# run code to set voltage
|
# run code to set voltage
|
||||||
self._voltage = value
|
self._voltage = value
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def power(self):
|
def power(self) -> bool:
|
||||||
# run code to get power state
|
# run code to get power state
|
||||||
return self._power
|
return self._power
|
||||||
|
|
||||||
@power.setter
|
@power.setter
|
||||||
def power(self, value):
|
def power(self, value: bool) -> None:
|
||||||
# run code to set power state
|
# run code to set power state
|
||||||
self._power = value
|
self._power = value
|
||||||
|
|
||||||
def reset(self):
|
def reset(self) -> None:
|
||||||
self.current = 0.0
|
self.current = 0.0
|
||||||
self.voltage = 0.0
|
self.voltage = 0.0
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
service = Device()
|
||||||
|
Server(service).run()
|
||||||
```
|
```
|
||||||
|
|
||||||
In the above example, we define a Device class that extends DataService. We define a few properties (current, voltage, power) and their getter and setter methods.
|
In the above example, we define a Device class that extends DataService. We define a few properties (current, voltage, power) and their getter and setter methods.
|
||||||
|
|
||||||
### Running the Server
|
### Running the Server
|
||||||
|
Binary file not shown.
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 33 KiB |
Loading…
x
Reference in New Issue
Block a user