Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
T
temperature-daemon
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
th
temperature-daemon
Commits
48c359c2
Commit
48c359c2
authored
6 years ago
by
Johannes Walcher
Browse files
Options
Downloads
Patches
Plain Diff
Added Readme
parent
6ce31bc2
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+67
-0
67 additions, 0 deletions
README.md
with
67 additions
and
0 deletions
README.md
0 → 100644
+
67
−
0
View file @
48c359c2
This is the StuStaNet Temperature Monitoring System.
# Hardware Setup and Protocol
The temperature sensors are ds18x20 sensors connected via the onewire protocol
to an esp32. The esp is connected via usb-serial to the host computer.
This sends roughly every second a measurement value from one of the sensors.
After a complete round it sends an empty line.
# Dependencies
pyserial-asyncio. And >=python3.5.
# Architecture
The communications is done within the temperature_daemon.py file as well as
error handling for the sensor measurements.
It will then call functions in plugins to do the majority of the work.
The plugins are located in the
`plugins`
folder.
A plugin has to include a
`def init(temperaturemonitor):`
initializer which
returns the plugin-class. See
`plugins/warnings.py`
for reference.
To see which plugin functions are called with what arguments search for
`call_plugin`
in the whole tree.
A plugin function can either be either async or not, both versions will be
executed properly.
Plugins can also call other plugins.
# Configuration
The system is configured via the
`tempermon.ini`
file, but the path can be changed
by supplying a single argument to the main executable.
It includes a bunch of default sections:
*
**serial**
: settings for the serial connection
*
**\<pluginname>**
: plugin specific settings
*
**\<one-wire-id>**
: every other section is interpreted as a sensor configuration
section. The configured sensor name is used for the collectd graphs, so if a
sensor is replaced, also change its name.
If a sensor is missing from this list, it will generate warning mails, as well
as for extra sensors. Only leave the sensors commented in, that are actually
used.
# Testing
In
`/tests`
the testing architecture is set up.
`run_tests.sh`
creates a testing socket as well as a emulated collectd socket.
Now testing can be started using the default configfile.
# Existing Plugins
If you create another plugin please add it to this list.
## Collectd
Store values into collectd when new sensor values are available as well as expose
a generic graph-storing for other plugins
## Mail
Contains the emailing system as well as all email templates.
Reacts to most
`err_*`
and
`warn_`
plugin calls and sends emails for them to the
configured clients
## Warnings
Analyse all available sensors, create statistics and analsye them and create
warnings, if required.
Here we can adopt new warning strategies.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment