Added some more docstrings to entities.

This commit is contained in:
Fabio Manganiello 2023-02-22 01:02:26 +01:00
parent 7fa545d7f8
commit cf219d5a48
Signed by untrusted user: blacklight
GPG key ID: D90FBA7F76362774
2 changed files with 9 additions and 0 deletions

View file

@ -8,6 +8,10 @@ from ._base import Entity
if 'device' not in Base.metadata: if 'device' not in Base.metadata:
class Device(Entity): class Device(Entity):
"""
Base class to model device entities.
"""
__tablename__ = 'device' __tablename__ = 'device'
id = Column( id = Column(

View file

@ -8,6 +8,11 @@ from .devices import Device
if 'dimmer' not in Base.metadata: if 'dimmer' not in Base.metadata:
class Dimmer(Device): class Dimmer(Device):
"""
This class models dimmer entities. A dimmer is any actionable entity
with numeric values and an optional min/max range.
"""
__tablename__ = 'dimmer' __tablename__ = 'dimmer'
id = Column( id = Column(