craftbeerpi4-pione/docs_src/source/properties.rst

32 lines
620 B
ReStructuredText
Raw Normal View History

2018-11-29 21:59:08 +01:00
Properties
===========
2018-12-09 22:20:33 +01:00
Properties can be use in all extensions.
During the startup the server scans all extension for variables of type Property.
Theses properties are exposed to the user for configuration during run time.
For example the user can set the GPIO number or the 1Wire Id.
Typical example how to use properties in an actor module.
Custom Actor
^^^^^^^^^^^^^
.. literalinclude:: ../../core/extension/dummyactor/__init__.py
:caption: __init__.py
:name: __init__-py
:language: python
:linenos:
2018-11-29 21:59:08 +01:00
.. autoclass:: core.api.property.Property
:members:
:private-members:
:undoc-members:
2018-12-09 22:20:33 +01:00
2018-11-29 21:59:08 +01:00