dodox/NuCon
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Typo in README

Browse Source
This commit is contained in:
Dominik Moritz Roth 2024-10-02 19:57:28 +02:00
parent 08a60e2850
commit 42f91a2279
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -65,11 +65,11 @@ Parameter properties:
Parameter methods: Parameter methods:
- `Nucon.<PARAMETER>.read()`: Get the current value of the parameter (alias for `value`) - `Nucon.<PARAMETER>.read()`: Get the current value of the parameter (alias for `value`)
- `Nucon.<PARAMETER>.write(new_value, force=False)`: Write a new value to the parameter. `force` will try to write even if the parameter is known as non-writable or out of known allowable range. - `Nucon.<PARAMETER>.write(new_value, force=False)`: Write a new value to the parameter. `force` will try to write even if the parameter is known as non-writable or out of known allowed range.
Class methods: Class methods:
- `Nucon.get(parameter)`: Get the value of a specific parameter. Also accepts string parameter names. - `Nucon.get(parameter)`: Get the value of a specific parameter. Also accepts string parameter names.
- `Nucon.set(parameter, value, force=False)`: Set the value of a specific parameter. Also accepts string parameter names. `force` will try to write even if the parameter is known as non-writable or out of known allowable range. - `Nucon.set(parameter, value, force=False)`: Set the value of a specific parameter. Also accepts string parameter names. `force` will try to write even if the parameter is known as non-writable or out of known allowed range.
- `Nucon.get_all_readable()`: Get a list of all readable parameters (which is all parameters) - `Nucon.get_all_readable()`: Get a list of all readable parameters (which is all parameters)
- `Nucon.get_all_writable()`: Get a list of all writable parameters - `Nucon.get_all_writable()`: Get a list of all writable parameters
- `Nucon.get_all()`: Get all parameter values as a dictionary - `Nucon.get_all()`: Get all parameter values as a dictionary