Skip to content

PatrickBaus/sensorDaemon

Repository files navigation

GitHub release CI workflow code style License: GPL v3 Docker

LabKraken Sensor Daemon

LabKraken is a logging daemon for lab applications. It can extract data from a number of sources commonly found in laboratories like:

The data is extracted from the devices and published via MQTT for further processing. Used with a datalogger like the Kraken Logger and a data visualisation frontend like Grafana it allows to precisely monitor labs and experiments in real-time.

LabKraken is written in Python using the asyncio framework and runs on both large scale servers and small Raspberry Pis.

Setup

LabKraken is best installed via the Docker repository provided with this repository.

Basic example docker-compose.yml for the LabKraken:

services:
  kraken:
    image: ghcr.io/patrickbaus/sensordaemon:latest
    container_name: kraken
    restart: always
    environment:
      - SENSORS_DATABASE_HOST=mongodb://foo:bar@database-server:27017
      - MQTT_HOST=mqtt-broker
      - NODE_ID=a4777632-3de5-4682-a0a7-3f86d879c74d 

Versioning

I use SemVer for versioning. For the versions available, see the tags on this repository.

Documentation

I use the Numpydoc style for documentation.

Authors

License

This project is licensed under the GPL v3 license - see the LICENSE file for details.