rattail-tempmon/rattail_tempmon/db/model.py

158 lines
5.1 KiB
Python
Raw Normal View History

# -*- coding: utf-8; -*-
2016-12-05 19:06:34 -06:00
################################################################################
#
# Rattail -- Retail Software Framework
# Copyright © 2010-2017 Lance Edgar
2016-12-05 19:06:34 -06:00
#
# This file is part of Rattail.
#
# Rattail is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
2016-12-05 19:06:34 -06:00
#
# Rattail is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
2016-12-05 19:06:34 -06:00
#
# You should have received a copy of the GNU General Public License along with
# Rattail. If not, see <http://www.gnu.org/licenses/>.
2016-12-05 19:06:34 -06:00
#
################################################################################
"""
Data models for tempmon
"""
from __future__ import unicode_literals, absolute_import
import datetime
import six
2016-12-05 19:06:34 -06:00
import sqlalchemy as sa
from sqlalchemy import orm
from sqlalchemy.ext.declarative import declarative_base
from rattail.db.model import uuid_column
from rattail.db.model.core import ModelBase
Base = declarative_base(cls=ModelBase)
@six.python_2_unicode_compatible
2016-12-05 19:06:34 -06:00
class Client(Base):
"""
Represents a tempmon client.
"""
__tablename__ = 'client'
__table_args__ = (
sa.UniqueConstraint('config_key', name='client_uq_config_key'),
)
uuid = uuid_column()
config_key = sa.Column(sa.String(length=50), nullable=False)
hostname = sa.Column(sa.String(length=255), nullable=False)
location = sa.Column(sa.String(length=255), nullable=True)
delay = sa.Column(sa.Integer(), nullable=True, doc="""
Number of seconds to delay between reading / recording temperatures. If
not set, a default of 60 seconds will be assumed.
""")
2016-12-05 19:06:34 -06:00
enabled = sa.Column(sa.Boolean(), nullable=False, default=False)
online = sa.Column(sa.Boolean(), nullable=False, default=False)
def __str__(self):
2016-12-05 19:06:34 -06:00
return '{} ({})'.format(self.config_key, self.hostname)
def enabled_probes(self):
return [probe for probe in self.probes if probe.enabled]
@six.python_2_unicode_compatible
2016-12-05 19:06:34 -06:00
class Probe(Base):
"""
Represents a probe connected to a tempmon client.
"""
__tablename__ = 'probe'
__table_args__ = (
sa.ForeignKeyConstraint(['client_uuid'], ['client.uuid'], name='probe_fk_client'),
sa.UniqueConstraint('config_key', name='probe_uq_config_key'),
)
uuid = uuid_column()
client_uuid = sa.Column(sa.String(length=32), nullable=False)
client = orm.relationship(
Client,
doc="""
Reference to the tempmon client to which this probe is connected.
""",
backref=orm.backref(
'probes',
cascade='all, delete-orphan',
2016-12-05 19:06:34 -06:00
doc="""
List of probes connected to this client.
"""))
config_key = sa.Column(sa.String(length=50), nullable=False)
appliance_type = sa.Column(sa.Integer(), nullable=False)
description = sa.Column(sa.String(length=255), nullable=False)
device_path = sa.Column(sa.String(length=255), nullable=True)
enabled = sa.Column(sa.Boolean(), nullable=False, default=True)
good_temp_min = sa.Column(sa.Integer(), nullable=False)
good_temp_max = sa.Column(sa.Integer(), nullable=False)
critical_temp_min = sa.Column(sa.Integer(), nullable=False)
critical_temp_max = sa.Column(sa.Integer(), nullable=False)
therm_status_timeout = sa.Column(sa.Integer(), nullable=False)
status_alert_timeout = sa.Column(sa.Integer(), nullable=False)
status = sa.Column(sa.Integer(), nullable=True)
status_changed = sa.Column(sa.DateTime(), nullable=True)
status_alert_sent = sa.Column(sa.DateTime(), nullable=True)
def __str__(self):
return self.description
2016-12-05 19:06:34 -06:00
@six.python_2_unicode_compatible
2016-12-05 19:06:34 -06:00
class Reading(Base):
"""
2017-04-01 16:37:00 -05:00
Represents a single temperature reading from a tempmon probe.
2016-12-05 19:06:34 -06:00
"""
__tablename__ = 'reading'
__table_args__ = (
sa.ForeignKeyConstraint(['client_uuid'], ['client.uuid'], name='reading_fk_client'),
sa.ForeignKeyConstraint(['probe_uuid'], ['probe.uuid'], name='reading_fk_probe'),
)
uuid = uuid_column()
client_uuid = sa.Column(sa.String(length=32), nullable=False)
client = orm.relationship(
Client,
doc="""
Reference to the tempmon client which took this reading.
2017-08-04 16:07:35 -05:00
""",
backref=orm.backref(
'readings',
cascade='all, delete-orphan'))
2016-12-05 19:06:34 -06:00
probe_uuid = sa.Column(sa.String(length=32), nullable=False)
probe = orm.relationship(
Probe,
doc="""
Reference to the tempmon probe which took this reading.
""",
backref=orm.backref(
'readings',
cascade='all, delete-orphan'))
2016-12-05 19:06:34 -06:00
taken = sa.Column(sa.DateTime(), nullable=False, default=datetime.datetime.utcnow)
degrees_f = sa.Column(sa.Numeric(precision=8, scale=4), nullable=False)
2016-12-05 19:06:34 -06:00
def __str__(self):
return str(self.degrees_f)